diff --git a/.gulp/common.iced b/.gulp/common.iced index 4f68ffe..c8a3881 100644 --- a/.gulp/common.iced +++ b/.gulp/common.iced @@ -407,7 +407,6 @@ Import github_apikey: argv.github_apikey or process.env.GITHUB_APIKEY or null nuget_apikey: argv.nuget_apikey or process.env.NUGET_APIKEY or null npm_apikey: argv.npm_apikey or process.env.NPM_APIKEY or null - autorest_home: process.env["autorest.home"] today: moment().format('YYYYMMDD') now: moment().format('YYYYMMDD-HHmm') force: argv.force or false diff --git a/.gulp/regeneration.iced b/.gulp/regeneration.iced index fb43f27..22ed212 100644 --- a/.gulp/regeneration.iced +++ b/.gulp/regeneration.iced @@ -16,6 +16,7 @@ regenExpected = (opts,done) -> "--standalone-modeler", "--clear-output-folder", "--output-artifact=code-model-v1.yaml", + "--output-artifact=code-model-v1-yaml.yaml", "--output-folder=#{opts.outputDir}/#{key}" ] diff --git a/package.json b/package.json index 14f1ba3..07d7b41 100644 --- a/package.json +++ b/package.json @@ -30,7 +30,7 @@ "homepage": "https://github.com/Azure/autorest.modeler/blob/master/README.md", "devDependencies": { "@microsoft.azure/autorest.testserver": "2.3.1", - "autorest": "^2.0.4194", + "autorest": "^2.0.4198", "coffee-script": "^1.11.1", "dotnet-sdk-2.0.0": "^1.4.4", "gulp": "^3.9.1", @@ -49,4 +49,4 @@ "dependencies": { "dotnet-2.0.0": "^1.4.4" } -} \ No newline at end of file +} diff --git a/readme.md b/readme.md index c52a3b4..dbc3036 100644 --- a/readme.md +++ b/readme.md @@ -15,6 +15,22 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio # AutoRest extension configuration +Emitter configuration: + +``` yaml +scope-cm/emitter: + input-artifact: code-model-v1 + is-object: true + output-uri-expr: | + "code-model-v1" + +scope-cm-yaml/emitter: + input-artifact: code-model-v1-yaml + is-object: true + output-uri-expr: | + "code-model-v1-yaml" +``` + ## Run it as a standalone (good for testing) ``` yaml $(standalone-modeler) @@ -32,6 +48,13 @@ pipeline: standalone/cm/emitter: input: transform scope: scope-cm/emitter + + standalone/cm/jsonx2yaml: + input: transform + output-artifact: code-model-v1-yaml + standalone/cm-yaml/emitter: + input: cm/jsonx2yaml + scope: scope-cm-yaml/emitter ``` ## Run it before generator diff --git a/test/Expected/azure-parameter-grouping/code-model-v1-yaml.yaml b/test/Expected/azure-parameter-grouping/code-model-v1-yaml.yaml new file mode 100644 index 0000000..5b7e863 --- /dev/null +++ b/test/Expected/azure-parameter-grouping/code-model-v1-yaml.yaml @@ -0,0 +1,434 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'https://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestParameterGroupingTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post a bunch of required parameters grouped + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: parameterGrouping + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequired + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-parameter-grouping: {} + x-ms-requestBody-name: body + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: body + serializedName: body + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-parameter-grouping: {} + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: customHeader + serializedName: customHeader + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: Query parameter with default + extensions: + x-ms-parameter-grouping: {} + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: query + serializedName: query + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Path parameter + extensions: + x-ms-parameter-grouping: + value: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: parameterGrouping_postRequired + url: '/parameterGrouping/postRequired/{path}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post a bunch of optional parameters grouped + group: + fixed: false + raw: parameterGrouping + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptional + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-parameter-grouping: {} + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: customHeader + serializedName: customHeader + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: Query parameter with default + extensions: + x-ms-parameter-grouping: {} + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: query + serializedName: query + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: parameterGrouping_postOptional + url: /parameterGrouping/postOptional + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post parameters from multiple different parameter groups + group: + fixed: false + raw: parameterGrouping + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postMultiParamGroups + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-parameter-grouping: + name: first-parameter-group + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: header-one + serializedName: header-one + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: Query parameter with default + extensions: + x-ms-parameter-grouping: + name: first-parameter-group + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: query-one + serializedName: query-one + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-parameter-grouping: + postfix: second-param-group + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: header-two + serializedName: header-two + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: Query parameter with default + extensions: + x-ms-parameter-grouping: + postfix: second-param-group + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: query-two + serializedName: query-two + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: parameterGrouping_postMultiParamGroups + url: /parameterGrouping/postMultipleParameterGroups + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post parameters with a shared parameter group object + group: + fixed: false + raw: parameterGrouping + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postSharedParameterGroupObject + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-parameter-grouping: + name: first-parameter-group + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: header-one + serializedName: header-one + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: Query parameter with default + extensions: + x-ms-parameter-grouping: + name: first-parameter-group + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: query-one + serializedName: query-one + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: parameterGrouping_postSharedParameterGroupObject + url: /parameterGrouping/sharedParameterGroupObject + name: + fixed: false + raw: ParameterGrouping + nameForProperty: ParameterGrouping + typeName: + fixed: false diff --git a/test/Expected/azure-report/code-model-v1-yaml.yaml b/test/Expected/azure-report/code-model-v1-yaml.yaml new file mode 100644 index 0000000..68f3c0a --- /dev/null +++ b/test/Expected/azure-report/code-model-v1-yaml.yaml @@ -0,0 +1,103 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestReportServiceForAzure +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get test coverage report + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getReport + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: getReport + url: /report/azure + name: + fixed: false + raw: '' + nameForProperty: AutoRestReportServiceForAzure + typeName: + fixed: false diff --git a/test/Expected/azure-resource-x/code-model-v1-yaml.yaml b/test/Expected/azure-resource-x/code-model-v1-yaml.yaml new file mode 100644 index 0000000..b8f01c9 --- /dev/null +++ b/test/Expected/azure-resource-x/code-model-v1-yaml.yaml @@ -0,0 +1,576 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Resource Flattening for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 + - &ref_1 + $type: CompositeType + containsConstantProperties: false + documentation: Some resource + extensions: + x-ms-azure-resource: true + externalDocsUrl: 'http://tempuri.org' + name: + fixed: false + raw: ResourceX + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Type + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Location + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Name + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: ResourceX + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: FlattenedResourceProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pname + realPath: + - pname + serializedName: pname + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: lsize + realPath: + - lsize + serializedName: lsize + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + serializedName: FlattenedResourceProperties + - &ref_3 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + name: + fixed: false + raw: FlattenedProduct + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: FlattenedProduct + - &ref_6 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ResourceCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: productresource + realPath: + - productresource + serializedName: productresource + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_3 + name: + fixed: false + name: + fixed: false + raw: arrayofresources + realPath: + - arrayofresources + serializedName: arrayofresources + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_3 + name: + fixed: false + raw: dictionaryofresources + realPath: + - dictionaryofresources + serializedName: dictionaryofresources + serializedName: ResourceCollection +modelsName: Models +name: AutoRestResourceFlatteningTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put External Resource as an Array + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putArray + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as an Array to put + extensions: + x-ms-requestBody-name: ResourceArray + isConstant: false + isRequired: false + location: body + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: ResourceArray + serializedName: ResourceArray + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putArray + url: /azure/resource-flatten/array + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get External Resource as an Array + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArray + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: SequenceType + elementType: *ref_3 + name: + fixed: false + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: getArray + url: /azure/resource-flatten/array + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put External Resource as a Dictionary + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDictionary + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as a Dictionary to put + extensions: + x-ms-requestBody-name: ResourceDictionary + isConstant: false + isRequired: false + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_3 + name: + fixed: false + raw: ResourceDictionary + serializedName: ResourceDictionary + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putDictionary + url: /azure/resource-flatten/dictionary + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get External Resource as a Dictionary + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionary + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_3 + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: getDictionary + url: /azure/resource-flatten/dictionary + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put External Resource as a ResourceCollection + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putResourceCollection + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as a ResourceCollection to put + extensions: + x-ms-requestBody-name: ResourceComplexObject + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: ResourceComplexObject + serializedName: ResourceComplexObject + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putResourceCollection + url: /azure/resource-flatten/resourcecollection + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get External Resource as a ResourceCollection + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getResourceCollection + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: getResourceCollection + url: /azure/resource-flatten/resourcecollection + name: + fixed: false + raw: '' + nameForProperty: AutoRestResourceFlatteningTestService + typeName: + fixed: false diff --git a/test/Expected/azure-resource/code-model-v1-yaml.yaml b/test/Expected/azure-resource/code-model-v1-yaml.yaml new file mode 100644 index 0000000..c0107b4 --- /dev/null +++ b/test/Expected/azure-resource/code-model-v1-yaml.yaml @@ -0,0 +1,576 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Resource Flattening for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 + - &ref_1 + $type: CompositeType + containsConstantProperties: false + documentation: Some resource + extensions: + x-ms-azure-resource: true + externalDocsUrl: 'http://tempuri.org' + name: + fixed: false + raw: Resource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Type + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Location + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Name + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: Resource + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: FlattenedResourceProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pname + realPath: + - pname + serializedName: pname + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: lsize + realPath: + - lsize + serializedName: lsize + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + serializedName: FlattenedResourceProperties + - &ref_3 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + name: + fixed: false + raw: FlattenedProduct + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: FlattenedProduct + - &ref_6 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ResourceCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: productresource + realPath: + - productresource + serializedName: productresource + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_3 + name: + fixed: false + name: + fixed: false + raw: arrayofresources + realPath: + - arrayofresources + serializedName: arrayofresources + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_3 + name: + fixed: false + raw: dictionaryofresources + realPath: + - dictionaryofresources + serializedName: dictionaryofresources + serializedName: ResourceCollection +modelsName: Models +name: AutoRestResourceFlatteningTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put External Resource as an Array + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putArray + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as an Array to put + extensions: + x-ms-requestBody-name: ResourceArray + isConstant: false + isRequired: false + location: body + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: ResourceArray + serializedName: ResourceArray + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putArray + url: /azure/resource-flatten/array + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get External Resource as an Array + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArray + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: SequenceType + elementType: *ref_3 + name: + fixed: false + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: getArray + url: /azure/resource-flatten/array + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put External Resource as a Dictionary + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDictionary + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as a Dictionary to put + extensions: + x-ms-requestBody-name: ResourceDictionary + isConstant: false + isRequired: false + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_3 + name: + fixed: false + raw: ResourceDictionary + serializedName: ResourceDictionary + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putDictionary + url: /azure/resource-flatten/dictionary + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get External Resource as a Dictionary + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionary + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_3 + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: getDictionary + url: /azure/resource-flatten/dictionary + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put External Resource as a ResourceCollection + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putResourceCollection + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as a ResourceCollection to put + extensions: + x-ms-requestBody-name: ResourceComplexObject + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: ResourceComplexObject + serializedName: ResourceComplexObject + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putResourceCollection + url: /azure/resource-flatten/resourcecollection + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get External Resource as a ResourceCollection + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getResourceCollection + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: getResourceCollection + url: /azure/resource-flatten/resourcecollection + name: + fixed: false + raw: '' + nameForProperty: AutoRestResourceFlatteningTestService + typeName: + fixed: false diff --git a/test/Expected/azure-special-properties/code-model-v1-yaml.yaml b/test/Expected/azure-special-properties/code-model-v1-yaml.yaml new file mode 100644 index 0000000..2c8d72d --- /dev/null +++ b/test/Expected/azure-special-properties/code-model-v1-yaml.yaml @@ -0,0 +1,1847 @@ +--- +apiVersion: 2015-07-01-preview +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + extensions: + requiredProperties: + - constantId + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: constantId + realPath: + - constantId + serializedName: constantId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +headerTypes: + - &ref_3 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for customNamedRequestId operation. + name: + fixed: false + raw: header-customNamedRequestId-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the foo-request-id. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: foo-request-id + realPath: + - foo-request-id + serializedName: foo-request-id + serializedName: header-customNamedRequestId-Headers + - &ref_4 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for customNamedRequestIdParamGrouping operation. + name: + fixed: false + raw: header-customNamedRequestIdParamGrouping-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the foo-request-id. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: foo-request-id + realPath: + - foo-request-id + serializedName: foo-request-id + serializedName: header-customNamedRequestIdParamGrouping-Headers + - &ref_5 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for customNamedRequestIdHead operation. + name: + fixed: false + raw: header-customNamedRequestIdHead-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the foo-request-id. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: foo-request-id + realPath: + - foo-request-id + serializedName: foo-request-id + serializedName: header-customNamedRequestIdHead-Headers +modelTypes: + - *ref_0 + - $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OdataFilter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: OdataFilter +modelsName: Models +name: AutoRestAzureSpecialParametersTestClient +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get method that overwrites x-ms-client-request header with value + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + group: + fixed: false + raw: x-ms-client-request-id + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: x-ms-client-request-id_Get + url: /azurespecials/overwrite/x-ms-client-request-id/method/ + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method that overwrites x-ms-client-request header with value + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + group: + fixed: false + raw: x-ms-client-request-id + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ParamGet + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This should appear as a method parameter, use value + '9C4D50EE-2D56-4CD3-8152-34347DC9F2B0' + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: x-ms-client-request-id + serializedName: x-ms-client-request-id + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: x-ms-client-request-id_ParamGet + url: /azurespecials/overwrite/x-ms-client-request-id/via-param/method/ + name: + fixed: false + raw: XMsClientRequestId + nameForProperty: XMsClientRequestId + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + POST method with subscriptionId modeled in credentials. Set the + credential subscriptionId to '1234-5678-9012-3456' to succeed + group: + fixed: false + raw: subscriptionInCredentials + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postMethodGlobalValid + parameters: + - clientProperty: &ref_1 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The subscription id, which appears in the path, always modeled + in credentials. The value is always '1234-5678-9012-3456' + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The subscription id, which appears in the path, always modeled + in credentials. The value is always '1234-5678-9012-3456' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: subscriptionInCredentials_postMethodGlobalValid + url: >- + /azurespecials/subscriptionId/method/string/none/path/global/1234-5678-9012-3456/{subscriptionId} + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + POST method with subscriptionId modeled in credentials. Set the + credential subscriptionId to null, and client-side validation should + prevent you from making this call + group: + fixed: false + raw: subscriptionInCredentials + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postMethodGlobalNull + parameters: + - clientProperty: *ref_1 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The subscription id, which appears in the path, always modeled + in credentials. The value is always '1234-5678-9012-3456' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: subscriptionInCredentials_postMethodGlobalNull + url: >- + /azurespecials/subscriptionId/method/string/none/path/global/null/{subscriptionId} + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + POST method with subscriptionId modeled in credentials. Set the + credential subscriptionId to '1234-5678-9012-3456' to succeed + group: + fixed: false + raw: subscriptionInCredentials + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postMethodGlobalNotProvidedValid + parameters: + - clientProperty: *ref_1 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The subscription id, which appears in the path, always modeled + in credentials. The value is always '1234-5678-9012-3456' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: &ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The api version, which appears in the query, the value is + always '2015-07-01-preview' + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The api version, which appears in the query, the value is always + '2015-07-01-preview' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: subscriptionInCredentials_postMethodGlobalNotProvidedValid + url: >- + /azurespecials/subscriptionId/method/string/none/path/globalNotProvided/1234-5678-9012-3456/{subscriptionId} + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + POST method with subscriptionId modeled in credentials. Set the + credential subscriptionId to '1234-5678-9012-3456' to succeed + group: + fixed: false + raw: subscriptionInCredentials + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postPathGlobalValid + parameters: + - clientProperty: *ref_1 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The subscription id, which appears in the path, always modeled + in credentials. The value is always '1234-5678-9012-3456' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: subscriptionInCredentials_postPathGlobalValid + url: >- + /azurespecials/subscriptionId/path/string/none/path/global/1234-5678-9012-3456/{subscriptionId} + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + POST method with subscriptionId modeled in credentials. Set the + credential subscriptionId to '1234-5678-9012-3456' to succeed + group: + fixed: false + raw: subscriptionInCredentials + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postSwaggerGlobalValid + parameters: + - clientProperty: *ref_1 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The subscription id, which appears in the path, always modeled + in credentials. The value is always '1234-5678-9012-3456' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: subscriptionInCredentials_postSwaggerGlobalValid + url: >- + /azurespecials/subscriptionId/swagger/string/none/path/global/1234-5678-9012-3456/{subscriptionId} + name: + fixed: false + raw: SubscriptionInCredentials + nameForProperty: SubscriptionInCredentials + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + POST method with subscriptionId modeled in the method. pass in + subscription id = '1234-5678-9012-3456' to succeed + group: + fixed: false + raw: subscriptionInMethod + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postMethodLocalValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This should appear as a method parameter, use value + '1234-5678-9012-3456' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: subscriptionInMethod_postMethodLocalValid + url: >- + /azurespecials/subscriptionId/method/string/none/path/local/1234-5678-9012-3456/{subscriptionId} + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + POST method with subscriptionId modeled in the method. pass in + subscription id = null, client-side validation should prevent you from + making this call + group: + fixed: false + raw: subscriptionInMethod + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postMethodLocalNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This should appear as a method parameter, use value null, + client-side validation should prvenet the call + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: subscriptionInMethod_postMethodLocalNull + url: >- + /azurespecials/subscriptionId/method/string/none/path/local/null/{subscriptionId} + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + POST method with subscriptionId modeled in the method. pass in + subscription id = '1234-5678-9012-3456' to succeed + group: + fixed: false + raw: subscriptionInMethod + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postPathLocalValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Should appear as a method parameter -use value + '1234-5678-9012-3456' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: subscriptionInMethod_postPathLocalValid + url: >- + /azurespecials/subscriptionId/path/string/none/path/local/1234-5678-9012-3456/{subscriptionId} + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + POST method with subscriptionId modeled in the method. pass in + subscription id = '1234-5678-9012-3456' to succeed + group: + fixed: false + raw: subscriptionInMethod + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postSwaggerLocalValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The subscriptionId, which appears in the path, the value is + always '1234-5678-9012-3456' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: subscriptionInMethod_postSwaggerLocalValid + url: >- + /azurespecials/subscriptionId/swagger/string/none/path/local/1234-5678-9012-3456/{subscriptionId} + name: + fixed: false + raw: SubscriptionInMethod + nameForProperty: SubscriptionInMethod + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: GET method with api-version modeled in global settings. + group: + fixed: false + raw: apiVersionDefault + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMethodGlobalValid + parameters: + - clientProperty: *ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The api version, which appears in the query, the value is always + '2015-07-01-preview' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: apiVersionDefault_getMethodGlobalValid + url: >- + /azurespecials/apiVersion/method/string/none/query/global/2015-07-01-preview + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: GET method with api-version modeled in global settings. + group: + fixed: false + raw: apiVersionDefault + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMethodGlobalNotProvidedValid + parameters: + - clientProperty: *ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The api version, which appears in the query, the value is always + '2015-07-01-preview' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: apiVersionDefault_getMethodGlobalNotProvidedValid + url: >- + /azurespecials/apiVersion/method/string/none/query/globalNotProvided/2015-07-01-preview + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: GET method with api-version modeled in global settings. + group: + fixed: false + raw: apiVersionDefault + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getPathGlobalValid + parameters: + - clientProperty: *ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The api version, which appears in the query, the value is always + '2015-07-01-preview' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: apiVersionDefault_getPathGlobalValid + url: >- + /azurespecials/apiVersion/path/string/none/query/global/2015-07-01-preview + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: GET method with api-version modeled in global settings. + group: + fixed: false + raw: apiVersionDefault + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSwaggerGlobalValid + parameters: + - clientProperty: *ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The api version, which appears in the query, the value is always + '2015-07-01-preview' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: apiVersionDefault_getSwaggerGlobalValid + url: >- + /azurespecials/apiVersion/swagger/string/none/query/global/2015-07-01-preview + name: + fixed: false + raw: ApiVersionDefault + nameForProperty: ApiVersionDefault + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with api-version modeled in the method. pass in + api-version = '2.0' to succeed + group: + fixed: false + raw: apiVersionLocal + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMethodLocalValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '2.0' + documentation: + fixed: false + raw: 'This should appear as a method parameter, use value ''2.0''' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: apiVersionLocal_getMethodLocalValid + url: /azurespecials/apiVersion/method/string/none/query/local/2.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with api-version modeled in the method. pass in + api-version = null to succeed + group: + fixed: false + raw: apiVersionLocal + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMethodLocalNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This should appear as a method parameter, use value null, this + should result in no serialized parameter + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: apiVersionLocal_getMethodLocalNull + url: /azurespecials/apiVersion/method/string/none/query/local/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with api-version modeled in the method. pass in + api-version = '2.0' to succeed + group: + fixed: false + raw: apiVersionLocal + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getPathLocalValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '2.0' + documentation: + fixed: false + raw: 'This should appear as a method parameter, use value ''2.0''' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: apiVersionLocal_getPathLocalValid + url: /azurespecials/apiVersion/path/string/none/query/local/2.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with api-version modeled in the method. pass in + api-version = '2.0' to succeed + group: + fixed: false + raw: apiVersionLocal + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSwaggerLocalValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '2.0' + documentation: + fixed: false + raw: >- + The api version, which appears in the query, the value is always + '2.0' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: apiVersionLocal_getSwaggerLocalValid + url: /azurespecials/apiVersion/swagger/string/none/query/local/2.0 + name: + fixed: false + raw: ApiVersionLocal + nameForProperty: ApiVersionLocal + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with unencoded path parameter with value + 'path1/path2/path3' + group: + fixed: false + raw: skipUrlEncoding + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMethodPathValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unencoded path parameter with value 'path1/path2/path3' + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: unencodedPathParam + serializedName: unencodedPathParam + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: skipUrlEncoding_getMethodPathValid + url: '/azurespecials/skipUrlEncoding/method/path/valid/{unencodedPathParam}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with unencoded path parameter with value + 'path1/path2/path3' + group: + fixed: false + raw: skipUrlEncoding + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getPathPathValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unencoded path parameter with value 'path1/path2/path3' + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: unencodedPathParam + serializedName: unencodedPathParam + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: skipUrlEncoding_getPathPathValid + url: '/azurespecials/skipUrlEncoding/path/path/valid/{unencodedPathParam}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with unencoded path parameter with value + 'path1/path2/path3' + group: + fixed: false + raw: skipUrlEncoding + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSwaggerPathValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: path1/path2/path3 + documentation: + fixed: false + raw: An unencoded path parameter with value 'path1/path2/path3' + extensions: + x-ms-skip-url-encoding: true + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: unencodedPathParam + serializedName: unencodedPathParam + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: skipUrlEncoding_getSwaggerPathValid + url: '/azurespecials/skipUrlEncoding/swagger/path/valid/{unencodedPathParam}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with unencoded query parameter with value + 'value1&q2=value2&q3=value3' + group: + fixed: false + raw: skipUrlEncoding + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMethodQueryValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unencoded query parameter with value + 'value1&q2=value2&q3=value3' + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: q1 + serializedName: q1 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: skipUrlEncoding_getMethodQueryValid + url: /azurespecials/skipUrlEncoding/method/query/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get method with unencoded query parameter with value null + group: + fixed: false + raw: skipUrlEncoding + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMethodQueryNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unencoded query parameter with value null + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: q1 + serializedName: q1 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: skipUrlEncoding_getMethodQueryNull + url: /azurespecials/skipUrlEncoding/method/query/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with unencoded query parameter with value + 'value1&q2=value2&q3=value3' + group: + fixed: false + raw: skipUrlEncoding + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getPathQueryValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unencoded query parameter with value + 'value1&q2=value2&q3=value3' + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: q1 + serializedName: q1 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: skipUrlEncoding_getPathQueryValid + url: /azurespecials/skipUrlEncoding/path/query/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get method with unencoded query parameter with value + 'value1&q2=value2&q3=value3' + group: + fixed: false + raw: skipUrlEncoding + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSwaggerQueryValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: value1&q2=value2&q3=value3 + documentation: + fixed: false + raw: >- + An unencoded query parameter with value + 'value1&q2=value2&q3=value3' + extensions: + x-ms-skip-url-encoding: true + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: q1 + serializedName: q1 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: skipUrlEncoding_getSwaggerQueryValid + url: /azurespecials/skipUrlEncoding/swagger/query/valid + name: + fixed: false + raw: SkipUrlEncoding + nameForProperty: SkipUrlEncoding + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Specify filter parameter with value '$filter=id gt 5 and name eq + 'foo'&$orderby=id&$top=10' + extensions: + x-ms-odata: '#/components/schemas/OdataFilter' + group: + fixed: false + raw: odata + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getWithFilter + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The filter parameter with value '$filter=id gt 5 and name eq + 'foo''. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The top parameter with value 10. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $top + serializedName: $top + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The orderby parameter with value id. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $orderby + serializedName: $orderby + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: odata_getWithFilter + url: /azurespecials/odata/filter + name: + fixed: false + raw: Odata + nameForProperty: Odata + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + headers: *ref_3 + isNullable: true + deprecated: false + description: >- + Send foo-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 in + the header of the request + extensions: + x-ms-request-id: foo-request-id + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: customNamedRequestId + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The fooRequestId + extensions: + x-ms-client-request-id: true + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: foo-client-request-id + serializedName: foo-client-request-id + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_3 + isNullable: true + returnType: + headers: *ref_3 + isNullable: true + serializedName: header_customNamedRequestId + url: /azurespecials/customNamedRequestId + - defaultResponse: + body: *ref_0 + headers: *ref_4 + isNullable: true + deprecated: false + description: >- + Send foo-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 in + the header of the request, via a parameter group + extensions: + x-ms-request-id: foo-request-id + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: customNamedRequestIdParamGrouping + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The fooRequestId + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: {} + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: foo-client-request-id + serializedName: foo-client-request-id + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_4 + isNullable: true + returnType: + headers: *ref_4 + isNullable: true + serializedName: header_customNamedRequestIdParamGrouping + url: /azurespecials/customNamedRequestIdParamGrouping + - defaultResponse: + body: *ref_0 + headers: *ref_5 + isNullable: true + deprecated: false + description: >- + Send foo-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 in + the header of the request + extensions: + x-ms-request-id: foo-request-id + group: + fixed: false + raw: header + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: customNamedRequestIdHead + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The fooRequestId + extensions: + x-ms-client-request-id: true + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: foo-client-request-id + serializedName: foo-client-request-id + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + headers: *ref_5 + isNullable: true + OK: + headers: *ref_5 + isNullable: true + returnType: + headers: *ref_5 + isNullable: true + serializedName: header_customNamedRequestIdHead + url: /azurespecials/customNamedRequestIdHead + name: + fixed: false + raw: Header + nameForProperty: Header + typeName: + fixed: false +properties: + - *ref_1 + - *ref_2 diff --git a/test/Expected/body-array/code-model-v1-yaml.yaml b/test/Expected/body-array/code-model-v1-yaml.yaml new file mode 100644 index 0000000..46c88a4 --- /dev/null +++ b/test/Expected/body-array/code-model-v1-yaml.yaml @@ -0,0 +1,2751 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest Swagger BAT +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - &ref_35 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Product + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: integer + realPath: + - integer + serializedName: integer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: string + realPath: + - string + serializedName: string + serializedName: Product + - *ref_0 +modelsName: Models +name: AutoRestSwaggerBATArrayService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null array value + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: array_getNull + url: /array/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get invalid array [1, 2, 3' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: array_getInvalid + url: /array/invalid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get empty array value []' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: array_getEmpty + url: /array/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set array value empty []' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putEmpty + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putEmpty + url: /array/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get boolean array value [true, false, false, true]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanTfft + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: array_getBooleanTfft + url: /array/prim/boolean/tfft + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set array value empty [true, false, false, true]' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBooleanTfft + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putBooleanTfft + url: /array/prim/boolean/tfft + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get boolean array value [true, null, false]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: array_getBooleanInvalidNull + url: /array/prim/boolean/true.null.false + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get boolean array value [true, ''boolean'', false]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: array_getBooleanInvalidString + url: /array/prim/boolean/true.boolean.false + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get integer array value [1, -1, 3, 300]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntegerValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_7 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + isNullable: true + returnType: + body: *ref_7 + isNullable: true + serializedName: array_getIntegerValid + url: /array/prim/integer/1.-1.3.300 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set array value empty [1, -1, 3, 300]' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putIntegerValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putIntegerValid + url: /array/prim/integer/1.-1.3.300 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get integer array value [1, null, 0]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_8 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: array_getIntInvalidNull + url: /array/prim/integer/1.null.zero + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get integer array value [1, ''integer'', 0]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_9 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: array_getIntInvalidString + url: /array/prim/integer/1.integer.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get integer array value [1, -1, 3, 300]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLongValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_10 + $type: SequenceType + elementType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + isNullable: true + returnType: + body: *ref_10 + isNullable: true + serializedName: array_getLongValid + url: /array/prim/long/1.-1.3.300 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set array value empty [1, -1, 3, 300]' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putLongValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putLongValid + url: /array/prim/long/1.-1.3.300 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get long array value [1, null, 0]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLongInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_11 + $type: SequenceType + elementType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: array_getLongInvalidNull + url: /array/prim/long/1.null.zero + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get long array value [1, ''integer'', 0]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLongInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_12 + $type: SequenceType + elementType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + isNullable: true + returnType: + body: *ref_12 + isNullable: true + serializedName: array_getLongInvalidString + url: /array/prim/long/1.integer.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get float array value [0, -0.01, 1.2e20]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getFloatValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_13 + $type: SequenceType + elementType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: array_getFloatValid + url: /array/prim/float/0--0.01-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set array value [0, -0.01, 1.2e20]' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putFloatValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putFloatValid + url: /array/prim/float/0--0.01-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get float array value [0.0, null, -1.2e20]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getFloatInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_14 + $type: SequenceType + elementType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: array_getFloatInvalidNull + url: /array/prim/float/0.0-null-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get boolean array value [1.0, ''number'', 0.0]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getFloatInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_15 + $type: SequenceType + elementType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + isNullable: true + returnType: + body: *ref_15 + isNullable: true + serializedName: array_getFloatInvalidString + url: /array/prim/float/1.number.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get float array value [0, -0.01, 1.2e20]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDoubleValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_16 + $type: SequenceType + elementType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + isNullable: true + returnType: + body: *ref_16 + isNullable: true + serializedName: array_getDoubleValid + url: /array/prim/double/0--0.01-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set array value [0, -0.01, 1.2e20]' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDoubleValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putDoubleValid + url: /array/prim/double/0--0.01-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get float array value [0.0, null, -1.2e20]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDoubleInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_17 + $type: SequenceType + elementType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + isNullable: true + returnType: + body: *ref_17 + isNullable: true + serializedName: array_getDoubleInvalidNull + url: /array/prim/double/0.0-null-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get boolean array value [1.0, ''number'', 0.0]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDoubleInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_18 + $type: SequenceType + elementType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + isNullable: true + returnType: + body: *ref_18 + isNullable: true + serializedName: array_getDoubleInvalidString + url: /array/prim/double/1.number.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get string array value [''foo1'', ''foo2'', ''foo3'']' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getStringValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_19 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_19 + isNullable: true + serializedName: array_getStringValid + url: /array/prim/string/foo1.foo2.foo3 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set array value [''foo1'', ''foo2'', ''foo3'']' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putStringValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putStringValid + url: /array/prim/string/foo1.foo2.foo3 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get string array value [''foo'', null, ''foo2'']' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getStringWithNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_20 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_20 + isNullable: true + serializedName: array_getStringWithNull + url: /array/prim/string/foo.null.foo2 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get string array value [''foo'', 123, ''foo2'']' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getStringWithInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_21 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_21 + isNullable: true + serializedName: array_getStringWithInvalid + url: /array/prim/string/foo.123.foo2 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get uuid array value ['6dcc7237-45fe-45c4-8a6b-3a8a3f625652', + 'd1399005-30f7-40d6-8da6-dd7c89ad34db', + 'f42f6aa1-a5bc-4ddf-907e-5f915de43205'] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUuidValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_22 + $type: SequenceType + elementType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + isNullable: true + returnType: + body: *ref_22 + isNullable: true + serializedName: array_getUuidValid + url: /array/prim/uuid/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set array value ['6dcc7237-45fe-45c4-8a6b-3a8a3f625652', + 'd1399005-30f7-40d6-8da6-dd7c89ad34db', + 'f42f6aa1-a5bc-4ddf-907e-5f915de43205'] + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putUuidValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putUuidValid + url: /array/prim/uuid/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get uuid array value [''6dcc7237-45fe-45c4-8a6b-3a8a3f625652'', ''foo'']' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUuidInvalidChars + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_23 + $type: SequenceType + elementType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + isNullable: true + returnType: + body: *ref_23 + isNullable: true + serializedName: array_getUuidInvalidChars + url: /array/prim/uuid/invalidchars + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get integer array value [''2000-12-01'', ''1980-01-02'', ''1492-10-12'']' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_24 + $type: SequenceType + elementType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + isNullable: true + returnType: + body: *ref_24 + isNullable: true + serializedName: array_getDateValid + url: /array/prim/date/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set array value [''2000-12-01'', ''1980-01-02'', ''1492-10-12'']' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDateValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putDateValid + url: /array/prim/date/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get date array value [''2012-01-01'', null, ''1776-07-04'']' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_25 + $type: SequenceType + elementType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: array_getDateInvalidNull + url: /array/prim/date/invalidnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get date array value [''2011-03-22'', ''date'']' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateInvalidChars + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_26 + $type: SequenceType + elementType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + isNullable: true + returnType: + body: *ref_26 + isNullable: true + serializedName: array_getDateInvalidChars + url: /array/prim/date/invalidchars + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get date-time array value ['2000-12-01t00:00:01z', + '1980-01-02T00:11:35+01:00', '1492-10-12T10:15:01-08:00'] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTimeValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_27 + $type: SequenceType + elementType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: array_getDateTimeValid + url: /array/prim/date-time/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set array value ['2000-12-01t00:00:01z', '1980-01-02T00:11:35+01:00', + '1492-10-12T10:15:01-08:00'] + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDateTimeValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putDateTimeValid + url: /array/prim/date-time/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get date array value [''2000-12-01t00:00:01z'', null]' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTimeInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_28 + $type: SequenceType + elementType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + isNullable: true + returnType: + body: *ref_28 + isNullable: true + serializedName: array_getDateTimeInvalidNull + url: /array/prim/date-time/invalidnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get date array value [''2000-12-01t00:00:01z'', ''date-time'']' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTimeInvalidChars + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_29 + $type: SequenceType + elementType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + isNullable: true + returnType: + body: *ref_29 + isNullable: true + serializedName: array_getDateTimeInvalidChars + url: /array/prim/date-time/invalidchars + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get date-time array value ['Fri, 01 Dec 2000 00:00:01 GMT', 'Wed, 02 + Jan 1980 00:11:35 GMT', 'Wed, 12 Oct 1492 10:15:01 GMT'] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTimeRfc1123Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_30 + $type: SequenceType + elementType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + isNullable: true + returnType: + body: *ref_30 + isNullable: true + serializedName: array_getDateTimeRfc1123Valid + url: /array/prim/date-time-rfc1123/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set array value ['Fri, 01 Dec 2000 00:00:01 GMT', 'Wed, 02 Jan 1980 + 00:11:35 GMT', 'Wed, 12 Oct 1492 10:15:01 GMT'] + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDateTimeRfc1123Valid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putDateTimeRfc1123Valid + url: /array/prim/date-time-rfc1123/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get duration array value [''P123DT22H14M12.011S'', ''P5DT1H0M0S'']' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDurationValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_31 + $type: SequenceType + elementType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + isNullable: true + returnType: + body: *ref_31 + isNullable: true + serializedName: array_getDurationValid + url: /array/prim/duration/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set array value [''P123DT22H14M12.011S'', ''P5DT1H0M0S'']' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDurationValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putDurationValid + url: /array/prim/duration/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get byte array value [hex(FF FF FF FA), hex(01 02 03), hex (25, 29, + 43)] with each item encoded in base64 + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getByteValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_32 + $type: SequenceType + elementType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + isNullable: true + returnType: + body: *ref_32 + isNullable: true + serializedName: array_getByteValid + url: /array/prim/byte/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put the array value [hex(FF FF FF FA), hex(01 02 03), hex (25, 29, + 43)] with each elementencoded in base 64 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putByteValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putByteValid + url: /array/prim/byte/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get byte array value [hex(AB, AC, AD), null] with the first item + base64 encoded + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getByteInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_33 + $type: SequenceType + elementType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + isNullable: true + returnType: + body: *ref_33 + isNullable: true + serializedName: array_getByteInvalidNull + url: /array/prim/byte/invalidnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get array value ['a string that gets encoded with base64url', 'test + string' 'Lorem ipsum'] with the items base64url encoded + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBase64Url + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_34 + $type: SequenceType + elementType: + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + name: + fixed: false + isNullable: true + returnType: + body: *ref_34 + isNullable: true + serializedName: array_getBase64Url + url: /array/prim/base64url/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get array of complex type null value + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_36 + $type: SequenceType + elementType: *ref_35 + name: + fixed: false + isNullable: true + returnType: + body: *ref_36 + isNullable: true + serializedName: array_getComplexNull + url: /array/complex/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get empty array of complex type []' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_37 + $type: SequenceType + elementType: *ref_35 + name: + fixed: false + isNullable: true + returnType: + body: *ref_37 + isNullable: true + serializedName: array_getComplexEmpty + url: /array/complex/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get array of complex type with null item [{'integer': 1 'string': + '2'}, null, {'integer': 5, 'string': '6'}] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexItemNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_38 + $type: SequenceType + elementType: *ref_35 + name: + fixed: false + isNullable: true + returnType: + body: *ref_38 + isNullable: true + serializedName: array_getComplexItemNull + url: /array/complex/itemnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get array of complex type with empty item [{'integer': 1 'string': + '2'}, {}, {'integer': 5, 'string': '6'}] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexItemEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_39 + $type: SequenceType + elementType: *ref_35 + name: + fixed: false + isNullable: true + returnType: + body: *ref_39 + isNullable: true + serializedName: array_getComplexItemEmpty + url: /array/complex/itemempty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get array of complex type with [{'integer': 1 'string': '2'}, + {'integer': 3, 'string': '4'}, {'integer': 5, 'string': '6'}] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_40 + $type: SequenceType + elementType: *ref_35 + name: + fixed: false + isNullable: true + returnType: + body: *ref_40 + isNullable: true + serializedName: array_getComplexValid + url: /array/complex/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put an array of complex type with values [{'integer': 1 'string': + '2'}, {'integer': 3, 'string': '4'}, {'integer': 5, 'string': '6'}] + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putComplexValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: *ref_35 + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putComplexValid + url: /array/complex/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a null array + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_41 + $type: SequenceType + elementType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + isNullable: true + returnType: + body: *ref_41 + isNullable: true + serializedName: array_getArrayNull + url: /array/array/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get an empty array []' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_42 + $type: SequenceType + elementType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + isNullable: true + returnType: + body: *ref_42 + isNullable: true + serializedName: array_getArrayEmpty + url: /array/array/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of array of strings [['1', '2', '3'], null, ['7', '8', + '9']] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayItemNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_43 + $type: SequenceType + elementType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + isNullable: true + returnType: + body: *ref_43 + isNullable: true + serializedName: array_getArrayItemNull + url: /array/array/itemnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of array of strings [['1', '2', '3'], [], ['7', '8', + '9']] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayItemEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_44 + $type: SequenceType + elementType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + isNullable: true + returnType: + body: *ref_44 + isNullable: true + serializedName: array_getArrayItemEmpty + url: /array/array/itemempty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of array of strings [['1', '2', '3'], ['4', '5', '6'], + ['7', '8', '9']] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_45 + $type: SequenceType + elementType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + isNullable: true + returnType: + body: *ref_45 + isNullable: true + serializedName: array_getArrayValid + url: /array/array/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put An array of array of strings [['1', '2', '3'], ['4', '5', '6'], + ['7', '8', '9']] + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putArrayValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putArrayValid + url: /array/array/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get an array of Dictionaries with value null + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_46 + $type: SequenceType + elementType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_46 + isNullable: true + serializedName: array_getDictionaryNull + url: /array/dictionary/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get an array of Dictionaries of type with value []' + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_47 + $type: SequenceType + elementType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_47 + isNullable: true + serializedName: array_getDictionaryEmpty + url: /array/dictionary/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of Dictionaries of type with value + [{'1': 'one', '2': 'two', '3': 'three'}, null, {'7': 'seven', '8': + 'eight', '9': 'nine'}] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryItemNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_48 + $type: SequenceType + elementType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_48 + isNullable: true + serializedName: array_getDictionaryItemNull + url: /array/dictionary/itemnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of Dictionaries of type with value + [{'1': 'one', '2': 'two', '3': 'three'}, {}, {'7': 'seven', '8': + 'eight', '9': 'nine'}] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryItemEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_49 + $type: SequenceType + elementType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_49 + isNullable: true + serializedName: array_getDictionaryItemEmpty + url: /array/dictionary/itemempty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of Dictionaries of type with value + [{'1': 'one', '2': 'two', '3': 'three'}, {'4': 'four', '5': 'five', + '6': 'six'}, {'7': 'seven', '8': 'eight', '9': 'nine'}] + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_50 + $type: SequenceType + elementType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_50 + isNullable: true + serializedName: array_getDictionaryValid + url: /array/dictionary/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of Dictionaries of type with value + [{'1': 'one', '2': 'two', '3': 'three'}, {'4': 'four', '5': 'five', + '6': 'six'}, {'7': 'seven', '8': 'eight', '9': 'nine'}] + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDictionaryValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putDictionaryValid + url: /array/dictionary/valid + name: + fixed: false + raw: Array + nameForProperty: Array + typeName: + fixed: false diff --git a/test/Expected/body-boolean.quirks/code-model-v1-yaml.yaml b/test/Expected/body-boolean.quirks/code-model-v1-yaml.yaml new file mode 100644 index 0000000..cd584c1 --- /dev/null +++ b/test/Expected/body-boolean.quirks/code-model-v1-yaml.yaml @@ -0,0 +1,285 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestBoolTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get true Boolean value + group: + fixed: false + raw: bool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getTrue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: bool_getTrue + url: /bool/true + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Set Boolean value true + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: bool + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putTrue + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: boolBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolBody + serializedName: boolBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: bool_putTrue + url: /bool/true + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get false Boolean value + group: + fixed: false + raw: bool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getFalse + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: bool_getFalse + url: /bool/false + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Set Boolean value false + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: bool + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putFalse + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: boolBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolBody + serializedName: boolBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: bool_putFalse + url: /bool/false + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null Boolean value + group: + fixed: false + raw: bool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: bool_getNull + url: /bool/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid Boolean value + group: + fixed: false + raw: bool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: bool_getInvalid + url: /bool/invalid + name: + fixed: false + raw: Bool + nameForProperty: Bool + typeName: + fixed: false diff --git a/test/Expected/body-boolean/code-model-v1-yaml.yaml b/test/Expected/body-boolean/code-model-v1-yaml.yaml new file mode 100644 index 0000000..c8d7564 --- /dev/null +++ b/test/Expected/body-boolean/code-model-v1-yaml.yaml @@ -0,0 +1,287 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestBoolTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get true Boolean value + group: + fixed: false + raw: bool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getTrue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: bool_getTrue + url: /bool/true + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Set Boolean value true + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: bool + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putTrue + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 'true' + documentation: + fixed: false + extensions: + x-ms-requestBody-name: boolBody + isConstant: true + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolBody + serializedName: boolBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: bool_putTrue + url: /bool/true + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get false Boolean value + group: + fixed: false + raw: bool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getFalse + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: bool_getFalse + url: /bool/false + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Set Boolean value false + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: bool + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putFalse + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + extensions: + x-ms-requestBody-name: boolBody + isConstant: true + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolBody + serializedName: boolBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: bool_putFalse + url: /bool/false + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null Boolean value + group: + fixed: false + raw: bool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: bool_getNull + url: /bool/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid Boolean value + group: + fixed: false + raw: bool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: bool_getInvalid + url: /bool/invalid + name: + fixed: false + raw: Bool + nameForProperty: Bool + typeName: + fixed: false diff --git a/test/Expected/body-byte/code-model-v1-yaml.yaml b/test/Expected/body-byte/code-model-v1-yaml.yaml new file mode 100644 index 0000000..e4c2f17 --- /dev/null +++ b/test/Expected/body-byte/code-model-v1-yaml.yaml @@ -0,0 +1,246 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest Swagger BAT +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestSwaggerBATByteService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null byte value + group: + fixed: false + raw: byte + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: byte_getNull + url: /byte/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get empty byte value '' + group: + fixed: false + raw: byte + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: byte_getEmpty + url: /byte/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get non-ascii byte string hex(FF FE FD FC FB FA F9 F8 F7 F6) + group: + fixed: false + raw: byte + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNonAscii + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: byte_getNonAscii + url: /byte/nonAscii + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put non-ascii byte string hex(FF FE FD FC FB FA F9 F8 F7 F6) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: byte + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNonAscii + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Base64-encoded non-ascii byte string hex(FF FE FD FC FB FA F9 F8 + F7 F6) + extensions: + x-ms-requestBody-name: byteBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: byteBody + serializedName: byteBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: byte_putNonAscii + url: /byte/nonAscii + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get invalid byte value '':::SWAGGER::::''' + group: + fixed: false + raw: byte + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: byte_getInvalid + url: /byte/invalid + name: + fixed: false + raw: Byte + nameForProperty: Byte + typeName: + fixed: false diff --git a/test/Expected/body-complex/code-model-v1-yaml.yaml b/test/Expected/body-complex/code-model-v1-yaml.yaml new file mode 100644 index 0000000..a8518f7 --- /dev/null +++ b/test/Expected/body-complex/code-model-v1-yaml.yaml @@ -0,0 +1,3152 @@ +--- +apiVersion: '2016-02-29' +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +enumTypes: + - &ref_1 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: CMYKColors + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: cyan + serializedName: cyan + - name: Magenta + serializedName: Magenta + - name: YELLOW + serializedName: YELLOW + - name: blacK + serializedName: blacK +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 + - &ref_8 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: basic + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Basic Id + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name property with a very long description that does not fit on a + single line and a line break. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: true + name: CMYKColors + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: color + realPath: + - color + serializedName: color + serializedName: basic + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: pet + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: pet + - &ref_3 + $type: CompositeType + baseModelType: *ref_2 + containsConstantProperties: false + name: + fixed: false + raw: dog + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: food + realPath: + - food + serializedName: food + serializedName: dog + - &ref_4 + $type: CompositeType + baseModelType: *ref_2 + containsConstantProperties: false + name: + fixed: false + raw: cat + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: color + realPath: + - color + serializedName: color + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_3 + name: + fixed: false + name: + fixed: false + raw: hates + realPath: + - hates + serializedName: hates + serializedName: cat + - &ref_22 + $type: CompositeType + baseModelType: *ref_4 + containsConstantProperties: false + name: + fixed: false + raw: siamese + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: breed + realPath: + - breed + serializedName: breed + serializedName: siamese + - &ref_5 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Fish + polymorphicDiscriminator: fishtype + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: species + realPath: + - species + serializedName: species + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: length + realPath: + - length + serializedName: length + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_5 + name: + fixed: false + name: + fixed: false + raw: siblings + realPath: + - siblings + serializedName: siblings + serializedName: Fish + - &ref_6 + $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + name: + fixed: false + raw: salmon + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: iswild + realPath: + - iswild + serializedName: iswild + serializedName: salmon + - $type: CompositeType + baseModelType: *ref_6 + containsConstantProperties: false + name: + fixed: false + raw: smart_salmon + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unmatched properties from the message are deserialized this + collection + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: true + valueType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: additionalProperties + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: college_degree + realPath: + - college_degree + serializedName: college_degree + serializedName: smart_salmon + - &ref_7 + $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + name: + fixed: false + raw: shark + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: age + realPath: + - age + serializedName: age + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: birthday + realPath: + - birthday + serializedName: birthday + serializedName: shark + - $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + name: + fixed: false + raw: sawshark + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: picture + realPath: + - picture + serializedName: picture + serializedName: sawshark + - $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + extensions: + x-ms-discriminator-value: goblin + name: + fixed: false + raw: goblinshark + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: jawsize + realPath: + - jawsize + serializedName: jawsize + serializedName: goblin + - $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + name: + fixed: false + raw: cookiecuttershark + serializedName: cookiecuttershark + - &ref_9 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: int-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: field1 + realPath: + - field1 + serializedName: field1 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: field2 + realPath: + - field2 + serializedName: field2 + serializedName: int-wrapper + - &ref_10 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: long-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: field1 + realPath: + - field1 + serializedName: field1 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: field2 + realPath: + - field2 + serializedName: field2 + serializedName: long-wrapper + - &ref_11 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: float-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: field1 + realPath: + - field1 + serializedName: field1 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: field2 + realPath: + - field2 + serializedName: field2 + serializedName: float-wrapper + - &ref_12 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: double-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: field1 + realPath: + - field1 + serializedName: field1 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: >- + field_56_zeros_after_the_dot_and_negative_zero_before_dot_and_this_is_a_long_field_name_on_purpose + realPath: + - >- + field_56_zeros_after_the_dot_and_negative_zero_before_dot_and_this_is_a_long_field_name_on_purpose + serializedName: >- + field_56_zeros_after_the_dot_and_negative_zero_before_dot_and_this_is_a_long_field_name_on_purpose + serializedName: double-wrapper + - &ref_13 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: boolean-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: field_true + realPath: + - field_true + serializedName: field_true + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: field_false + realPath: + - field_false + serializedName: field_false + serializedName: boolean-wrapper + - &ref_14 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: string-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: field + realPath: + - field + serializedName: field + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: empty + realPath: + - empty + serializedName: empty + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: 'null' + realPath: + - 'null' + serializedName: 'null' + serializedName: string-wrapper + - &ref_15 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: date-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: field + realPath: + - field + serializedName: field + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: leap + realPath: + - leap + serializedName: leap + serializedName: date-wrapper + - &ref_16 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: datetime-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: field + realPath: + - field + serializedName: field + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: now + realPath: + - now + serializedName: now + serializedName: datetime-wrapper + - &ref_17 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: datetimerfc1123-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: field + realPath: + - field + serializedName: field + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: now + realPath: + - now + serializedName: now + serializedName: datetimerfc1123-wrapper + - &ref_18 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: duration-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: field + realPath: + - field + serializedName: field + serializedName: duration-wrapper + - &ref_19 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: byte-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: field + realPath: + - field + serializedName: field + serializedName: byte-wrapper + - &ref_20 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: array-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: array + realPath: + - array + serializedName: array + serializedName: array-wrapper + - &ref_21 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: dictionary-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: defaultProgram + realPath: + - defaultProgram + serializedName: defaultProgram + serializedName: dictionary-wrapper + - &ref_23 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: readonly-obj + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: size + realPath: + - size + serializedName: size + serializedName: readonly-obj +modelsName: Models +name: AutoRestComplexTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get complex type {id: 2, name: ''abc'', color: ''YELLOW''}' + group: + fixed: false + raw: basic + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: basic_getValid + url: /complex/basic/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Please put {id: 2, name: ''abc'', color: ''Magenta''}' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: basic + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Please put {id: 2, name: ''abc'', color: ''Magenta''}' + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_8 + name: + fixed: false + raw: complexBody + serializedName: complexBody + - clientProperty: &ref_24 + collectionFormat: none + defaultValue: + fixed: false + raw: 2014-04-01-preview + documentation: + fixed: false + raw: API ID. + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + raw: 2014-04-01-preview + documentation: + fixed: false + raw: API ID. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: basic_putValid + url: /complex/basic/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a basic complex type that is invalid for the local strong type + group: + fixed: false + raw: basic + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: basic_getInvalid + url: /complex/basic/invalid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a basic complex type that is empty + group: + fixed: false + raw: basic + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: basic_getEmpty + url: /complex/basic/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a basic complex type whose properties are null + group: + fixed: false + raw: basic + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: basic_getNull + url: /complex/basic/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get a basic complex type while the server doesn't provide a response + payload + group: + fixed: false + raw: basic + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNotProvided + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: basic_getNotProvided + url: /complex/basic/notprovided + name: + fixed: false + raw: Basic + nameForProperty: Basic + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with integer properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInt + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_9 + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: primitive_getInt + url: /complex/primitive/integer + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with integer properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putInt + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Please put -1 and 2 + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_9 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putInt + url: /complex/primitive/integer + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with long properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLong + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_10 + isNullable: true + returnType: + body: *ref_10 + isNullable: true + serializedName: primitive_getLong + url: /complex/primitive/long + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with long properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putLong + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Please put 1099511627775 and -999511627788 + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_10 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putLong + url: /complex/primitive/long + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with float properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getFloat + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_11 + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: primitive_getFloat + url: /complex/primitive/float + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with float properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putFloat + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Please put 1.05 and -0.003 + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_11 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putFloat + url: /complex/primitive/float + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with double properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDouble + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_12 + isNullable: true + returnType: + body: *ref_12 + isNullable: true + serializedName: primitive_getDouble + url: /complex/primitive/double + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with double properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDouble + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Please put 3e-100 and + -0.000000000000000000000000000000000000000000000000000000005 + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_12 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putDouble + url: /complex/primitive/double + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with bool properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBool + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_13 + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: primitive_getBool + url: /complex/primitive/bool + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with bool properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBool + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Please put true and false + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_13 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putBool + url: /complex/primitive/bool + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with string properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_14 + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: primitive_getString + url: /complex/primitive/string + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with string properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putString + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Please put ''goodrequest'', '''', and null' + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_14 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putString + url: /complex/primitive/string + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with date properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDate + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_15 + isNullable: true + returnType: + body: *ref_15 + isNullable: true + serializedName: primitive_getDate + url: /complex/primitive/date + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with date properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Please put '0001-01-01' and '2016-02-29' + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_15 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putDate + url: /complex/primitive/date + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with datetime properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_16 + isNullable: true + returnType: + body: *ref_16 + isNullable: true + serializedName: primitive_getDateTime + url: /complex/primitive/datetime + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with datetime properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDateTime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Please put '0001-01-01T12:00:00-04:00' and + '2015-05-18T11:38:00-08:00' + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_16 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putDateTime + url: /complex/primitive/datetime + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with datetimeRfc1123 properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTimeRfc1123 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_17 + isNullable: true + returnType: + body: *ref_17 + isNullable: true + serializedName: primitive_getDateTimeRfc1123 + url: /complex/primitive/datetimerfc1123 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with datetimeRfc1123 properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDateTimeRfc1123 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Please put 'Mon, 01 Jan 0001 12:00:00 GMT' and 'Mon, 18 May 2015 + 11:38:00 GMT' + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_17 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putDateTimeRfc1123 + url: /complex/primitive/datetimerfc1123 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with duration properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDuration + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_18 + isNullable: true + returnType: + body: *ref_18 + isNullable: true + serializedName: primitive_getDuration + url: /complex/primitive/duration + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with duration properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDuration + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Please put 'P123DT22H14M12.011S' + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_18 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putDuration + url: /complex/primitive/duration + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with byte properties + group: + fixed: false + raw: primitive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getByte + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_19 + isNullable: true + returnType: + body: *ref_19 + isNullable: true + serializedName: primitive_getByte + url: /complex/primitive/byte + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with byte properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: primitive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putByte + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Please put non-ascii byte string hex(FF FE FD FC 00 FA F9 F8 F7 + F6) + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_19 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: primitive_putByte + url: /complex/primitive/byte + name: + fixed: false + raw: Primitive + nameForProperty: Primitive + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with array property + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_20 + isNullable: true + returnType: + body: *ref_20 + isNullable: true + serializedName: array_getValid + url: /complex/array/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with array property + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Please put an array with 4 items: "1, 2, 3, 4", "", null, + "&S#$(*Y", "The quick brown fox jumps over the lazy dog" + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_20 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putValid + url: /complex/array/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with array property which is empty + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_20 + isNullable: true + returnType: + body: *ref_20 + isNullable: true + serializedName: array_getEmpty + url: /complex/array/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with array property which is empty + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: array + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Please put an empty array + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_20 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: array_putEmpty + url: /complex/array/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get complex types with array property while server doesn't provide a + response payload + group: + fixed: false + raw: array + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNotProvided + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_20 + isNullable: true + returnType: + body: *ref_20 + isNullable: true + serializedName: array_getNotProvided + url: /complex/array/notprovided + name: + fixed: false + raw: Array + nameForProperty: Array + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with dictionary property + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_21 + isNullable: true + returnType: + body: *ref_21 + isNullable: true + serializedName: dictionary_getValid + url: /complex/dictionary/typed/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with dictionary property + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Please put a dictionary with 5 key-value pairs: "txt":"notepad", + "bmp":"mspaint", "xls":"excel", "exe":"", "":null + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_21 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putValid + url: /complex/dictionary/typed/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with dictionary property which is empty + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_21 + isNullable: true + returnType: + body: *ref_21 + isNullable: true + serializedName: dictionary_getEmpty + url: /complex/dictionary/typed/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types with dictionary property which is empty + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Please put an empty dictionary + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_21 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putEmpty + url: /complex/dictionary/typed/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types with dictionary property which is null + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_21 + isNullable: true + returnType: + body: *ref_21 + isNullable: true + serializedName: dictionary_getNull + url: /complex/dictionary/typed/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get complex types with dictionary property while server doesn't + provide a response payload + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNotProvided + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_21 + isNullable: true + returnType: + body: *ref_21 + isNullable: true + serializedName: dictionary_getNotProvided + url: /complex/dictionary/typed/notprovided + name: + fixed: false + raw: Dictionary + nameForProperty: Dictionary + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types that extend others + group: + fixed: false + raw: inheritance + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_22 + isNullable: true + returnType: + body: *ref_22 + isNullable: true + serializedName: inheritance_getValid + url: /complex/inheritance/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types that extend others + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: inheritance + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Please put a siamese with id=2, name="Siameee", color=green, + breed=persion, which hates 2 dogs, the 1st one named "Potato" + with id=1 and food="tomato", and the 2nd one named "Tomato" with + id=-1 and food="french fries". + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_22 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: inheritance_putValid + url: /complex/inheritance/valid + name: + fixed: false + raw: Inheritance + nameForProperty: Inheritance + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types that are polymorphic + group: + fixed: false + raw: polymorphism + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_5 + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: polymorphism_getValid + url: /complex/polymorphism/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types that are polymorphic + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: polymorphism + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Please put a salmon that looks like this: + { + 'fishtype':'Salmon', + 'location':'alaska', + 'iswild':true, + 'species':'king', + 'length':1.0, + 'siblings':[ + { + 'fishtype':'Shark', + 'age':6, + 'birthday': '2012-01-05T01:00:00Z', + 'length':20.0, + 'species':'predator', + }, + { + 'fishtype':'Sawshark', + 'age':105, + 'birthday': '1900-01-05T01:00:00Z', + 'length':10.0, + 'picture': new Buffer([255, 255, 255, 255, 254]).toString('base64'), + 'species':'dangerous', + }, + { + 'fishtype': 'goblin', + 'age': 1, + 'birthday': '2015-08-08T00:00:00Z', + 'length': 30.0, + 'species': 'scary', + 'jawsize': 5 + } + ] + }; + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_5 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: polymorphism_putValid + url: /complex/polymorphism/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get complex types that are polymorphic, but not at the root of the + hierarchy; also have additional properties + group: + fixed: false + raw: polymorphism + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplicated + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: polymorphism_getComplicated + url: /complex/polymorphism/complicated + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put complex types that are polymorphic, but not at the root of the + hierarchy; also have additional properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: polymorphism + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putComplicated + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_6 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: polymorphism_putComplicated + url: /complex/polymorphism/complicated + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put complex types that are polymorphic, attempting to omit required + 'birthday' field - the request should not be allowed from the client + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: polymorphism + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putValidMissingRequired + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Please attempt put a sawshark that looks like this, the client + should not allow this data to be sent: + + { + "fishtype": "sawshark", + "species": "snaggle toothed", + "length": 18.5, + "age": 2, + "birthday": "2013-06-01T01:00:00Z", + "location": "alaska", + "picture": base64(FF FF FF FF FE), + "siblings": [ + { + "fishtype": "shark", + "species": "predator", + "birthday": "2012-01-05T01:00:00Z", + "length": 20, + "age": 6 + }, + { + "fishtype": "sawshark", + "species": "dangerous", + "picture": base64(FF FF FF FF FE), + "length": 10, + "age": 105 + } + ] + } + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_5 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: polymorphism_putValidMissingRequired + url: /complex/polymorphism/missingrequired/invalid + name: + fixed: false + raw: Polymorphism + nameForProperty: Polymorphism + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types that are polymorphic and have recursive references + group: + fixed: false + raw: polymorphicrecursive + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_5 + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: polymorphicrecursive_getValid + url: /complex/polymorphicrecursive/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types that are polymorphic and have recursive references + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: polymorphicrecursive + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Please put a salmon that looks like this: + { + "fishtype": "salmon", + "species": "king", + "length": 1, + "age": 1, + "location": "alaska", + "iswild": true, + "siblings": [ + { + "fishtype": "shark", + "species": "predator", + "length": 20, + "age": 6, + "siblings": [ + { + "fishtype": "salmon", + "species": "coho", + "length": 2, + "age": 2, + "location": "atlantic", + "iswild": true, + "siblings": [ + { + "fishtype": "shark", + "species": "predator", + "length": 20, + "age": 6 + }, + { + "fishtype": "sawshark", + "species": "dangerous", + "length": 10, + "age": 105 + } + ] + }, + { + "fishtype": "sawshark", + "species": "dangerous", + "length": 10, + "age": 105 + } + ] + }, + { + "fishtype": "sawshark", + "species": "dangerous", + "length": 10, + "age": 105 + } + ] + } + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_5 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: polymorphicrecursive_putValid + url: /complex/polymorphicrecursive/valid + name: + fixed: false + raw: Polymorphicrecursive + nameForProperty: Polymorphicrecursive + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get complex types that have readonly properties + group: + fixed: false + raw: readonlyproperty + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_23 + isNullable: true + returnType: + body: *ref_23 + isNullable: true + serializedName: readonlyproperty_getValid + url: /complex/readonlyproperty/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put complex types that have readonly properties + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: readonlyproperty + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: complexBody + isConstant: false + isRequired: true + location: body + modelType: *ref_23 + name: + fixed: false + raw: complexBody + serializedName: complexBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: readonlyproperty_putValid + url: /complex/readonlyproperty/valid + name: + fixed: false + raw: Readonlyproperty + nameForProperty: Readonlyproperty + typeName: + fixed: false +properties: + - *ref_24 diff --git a/test/Expected/body-date/code-model-v1-yaml.yaml b/test/Expected/body-date/code-model-v1-yaml.yaml new file mode 100644 index 0000000..2e69115 --- /dev/null +++ b/test/Expected/body-date/code-model-v1-yaml.yaml @@ -0,0 +1,355 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'https://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestDateTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null date value + group: + fixed: false + raw: date + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: date_getNull + url: /date/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid date value + group: + fixed: false + raw: date + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalidDate + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: date_getInvalidDate + url: /date/invaliddate + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get overflow date value + group: + fixed: false + raw: date + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getOverflowDate + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: date_getOverflowDate + url: /date/overflowdate + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get underflow date value + group: + fixed: false + raw: date + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUnderflowDate + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: date_getUnderflowDate + url: /date/underflowdate + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put max date value 9999-12-31 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: date + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putMaxDate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: dateBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: dateBody + serializedName: dateBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: date_putMaxDate + url: /date/max + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get max date value 9999-12-31 + group: + fixed: false + raw: date + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMaxDate + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: date_getMaxDate + url: /date/max + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put min date value 0000-01-01 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: date + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putMinDate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: dateBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: dateBody + serializedName: dateBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: date_putMinDate + url: /date/min + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get min date value 0000-01-01 + group: + fixed: false + raw: date + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMinDate + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: date_getMinDate + url: /date/min + name: + fixed: false + raw: Date + nameForProperty: Date + typeName: + fixed: false diff --git a/test/Expected/body-datetime-rfc1123/code-model-v1-yaml.yaml b/test/Expected/body-datetime-rfc1123/code-model-v1-yaml.yaml new file mode 100644 index 0000000..6900099 --- /dev/null +++ b/test/Expected/body-datetime-rfc1123/code-model-v1-yaml.yaml @@ -0,0 +1,387 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'https://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestRFC1123DateTimeTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null datetime value + group: + fixed: false + raw: datetimerfc1123 + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: datetimerfc1123_getNull + url: /datetimerfc1123/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid datetime value + group: + fixed: false + raw: datetimerfc1123 + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: datetimerfc1123_getInvalid + url: /datetimerfc1123/invalid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get overflow datetime value + group: + fixed: false + raw: datetimerfc1123 + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getOverflow + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: datetimerfc1123_getOverflow + url: /datetimerfc1123/overflow + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get underflow datetime value + group: + fixed: false + raw: datetimerfc1123 + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUnderflow + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: datetimerfc1123_getUnderflow + url: /datetimerfc1123/underflow + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Put max datetime value Fri, 31 Dec 9999 23:59:59 GMT' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: datetimerfc1123 + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putUtcMaxDateTime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: datetimeBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: datetimeBody + serializedName: datetimeBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: datetimerfc1123_putUtcMaxDateTime + url: /datetimerfc1123/max + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get max datetime value fri, 31 dec 9999 23:59:59 gmt' + group: + fixed: false + raw: datetimerfc1123 + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUtcLowercaseMaxDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: datetimerfc1123_getUtcLowercaseMaxDateTime + url: /datetimerfc1123/max/lowercase + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get max datetime value FRI, 31 DEC 9999 23:59:59 GMT' + group: + fixed: false + raw: datetimerfc1123 + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUtcUppercaseMaxDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: datetimerfc1123_getUtcUppercaseMaxDateTime + url: /datetimerfc1123/max/uppercase + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Put min datetime value Mon, 1 Jan 0001 00:00:00 GMT' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: datetimerfc1123 + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putUtcMinDateTime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: datetimeBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: datetimeBody + serializedName: datetimeBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: datetimerfc1123_putUtcMinDateTime + url: /datetimerfc1123/min + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get min datetime value Mon, 1 Jan 0001 00:00:00 GMT' + group: + fixed: false + raw: datetimerfc1123 + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUtcMinDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_7 + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + isNullable: true + returnType: + body: *ref_7 + isNullable: true + serializedName: datetimerfc1123_getUtcMinDateTime + url: /datetimerfc1123/min + name: + fixed: false + raw: Datetimerfc1123 + nameForProperty: Datetimerfc1123 + typeName: + fixed: false diff --git a/test/Expected/body-datetime/code-model-v1-yaml.yaml b/test/Expected/body-datetime/code-model-v1-yaml.yaml new file mode 100644 index 0000000..f59aed8 --- /dev/null +++ b/test/Expected/body-datetime/code-model-v1-yaml.yaml @@ -0,0 +1,783 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'https://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestDateTimeTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null datetime value + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: datetime_getNull + url: /datetime/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid datetime value + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: datetime_getInvalid + url: /datetime/invalid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get overflow datetime value + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getOverflow + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: datetime_getOverflow + url: /datetime/overflow + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get underflow datetime value + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUnderflow + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: datetime_getUnderflow + url: /datetime/underflow + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Put max datetime value 9999-12-31T23:59:59.9999999Z' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putUtcMaxDateTime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: datetimeBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: datetimeBody + serializedName: datetimeBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: datetime_putUtcMaxDateTime + url: /datetime/max/utc + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get max datetime value 9999-12-31t23:59:59.9999999z' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUtcLowercaseMaxDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: datetime_getUtcLowercaseMaxDateTime + url: /datetime/max/utc/lowercase + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get max datetime value 9999-12-31T23:59:59.9999999Z' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUtcUppercaseMaxDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: datetime_getUtcUppercaseMaxDateTime + url: /datetime/max/utc/uppercase + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put max datetime value with positive numoffset + 9999-12-31t23:59:59.9999999+14:00 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putLocalPositiveOffsetMaxDateTime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: datetimeBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: datetimeBody + serializedName: datetimeBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: datetime_putLocalPositiveOffsetMaxDateTime + url: /datetime/max/localpositiveoffset + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get max datetime value with positive num offset + 9999-12-31t23:59:59.9999999+14:00 + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLocalPositiveOffsetLowercaseMaxDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_7 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_7 + isNullable: true + serializedName: datetime_getLocalPositiveOffsetLowercaseMaxDateTime + url: /datetime/max/localpositiveoffset/lowercase + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get max datetime value with positive num offset + 9999-12-31T23:59:59.9999999+14:00 + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLocalPositiveOffsetUppercaseMaxDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_8 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: datetime_getLocalPositiveOffsetUppercaseMaxDateTime + url: /datetime/max/localpositiveoffset/uppercase + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put max datetime value with positive numoffset + 9999-12-31t23:59:59.9999999-14:00 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putLocalNegativeOffsetMaxDateTime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: datetimeBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: datetimeBody + serializedName: datetimeBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: datetime_putLocalNegativeOffsetMaxDateTime + url: /datetime/max/localnegativeoffset + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get max datetime value with positive num offset + 9999-12-31T23:59:59.9999999-14:00 + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLocalNegativeOffsetUppercaseMaxDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_9 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: datetime_getLocalNegativeOffsetUppercaseMaxDateTime + url: /datetime/max/localnegativeoffset/uppercase + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get max datetime value with positive num offset + 9999-12-31t23:59:59.9999999-14:00 + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLocalNegativeOffsetLowercaseMaxDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_10 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_10 + isNullable: true + serializedName: datetime_getLocalNegativeOffsetLowercaseMaxDateTime + url: /datetime/max/localnegativeoffset/lowercase + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Put min datetime value 0001-01-01T00:00:00Z' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putUtcMinDateTime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: datetimeBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: datetimeBody + serializedName: datetimeBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: datetime_putUtcMinDateTime + url: /datetime/min/utc + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get min datetime value 0001-01-01T00:00:00Z' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUtcMinDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_11 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: datetime_getUtcMinDateTime + url: /datetime/min/utc + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Put min datetime value 0001-01-01T00:00:00+14:00' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putLocalPositiveOffsetMinDateTime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: datetimeBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: datetimeBody + serializedName: datetimeBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: datetime_putLocalPositiveOffsetMinDateTime + url: /datetime/min/localpositiveoffset + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get min datetime value 0001-01-01T00:00:00+14:00' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLocalPositiveOffsetMinDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_12 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_12 + isNullable: true + serializedName: datetime_getLocalPositiveOffsetMinDateTime + url: /datetime/min/localpositiveoffset + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Put min datetime value 0001-01-01T00:00:00-14:00' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putLocalNegativeOffsetMinDateTime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: datetimeBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: datetimeBody + serializedName: datetimeBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: datetime_putLocalNegativeOffsetMinDateTime + url: /datetime/min/localnegativeoffset + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get min datetime value 0001-01-01T00:00:00-14:00' + group: + fixed: false + raw: datetime + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLocalNegativeOffsetMinDateTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_13 + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: datetime_getLocalNegativeOffsetMinDateTime + url: /datetime/min/localnegativeoffset + name: + fixed: false + raw: Datetime + nameForProperty: Datetime + typeName: + fixed: false diff --git a/test/Expected/body-dictionary/code-model-v1-yaml.yaml b/test/Expected/body-dictionary/code-model-v1-yaml.yaml new file mode 100644 index 0000000..8edc366 --- /dev/null +++ b/test/Expected/body-dictionary/code-model-v1-yaml.yaml @@ -0,0 +1,2812 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest Swagger BAT +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - &ref_36 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Widget + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: integer + realPath: + - integer + serializedName: integer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: string + realPath: + - string + serializedName: string + serializedName: Widget + - *ref_0 +modelsName: Models +name: AutoRestSwaggerBATdictionaryService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null dictionary value + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: dictionary_getNull + url: /dictionary/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get empty dictionary value {}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: dictionary_getEmpty + url: /dictionary/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set dictionary value empty {}' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putEmpty + url: /dictionary/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get Dictionary with null value + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNullValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: dictionary_getNullValue + url: /dictionary/nullvalue + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get Dictionary with null key + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNullKey + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: dictionary_getNullKey + url: /dictionary/nullkey + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get Dictionary with key as empty string + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmptyStringKey + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: dictionary_getEmptyStringKey + url: /dictionary/keyemptystring + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid Dictionary value + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: dictionary_getInvalid + url: /dictionary/invalid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get boolean dictionary value {"0": true, "1": false, "2": false, "3": + true } + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanTfft + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_7 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_7 + isNullable: true + serializedName: dictionary_getBooleanTfft + url: /dictionary/prim/boolean/tfft + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set dictionary value empty {"0": true, "1": false, "2": false, "3": + true } + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBooleanTfft + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putBooleanTfft + url: /dictionary/prim/boolean/tfft + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get boolean dictionary value {"0": true, "1": null, "2": false }' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_8 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: dictionary_getBooleanInvalidNull + url: /dictionary/prim/boolean/true.null.false + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get boolean dictionary value ''{"0": true, "1": "boolean", "2": false}''' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_9 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: dictionary_getBooleanInvalidString + url: /dictionary/prim/boolean/true.boolean.false + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get integer dictionary value {"0": 1, "1": -1, "2": 3, "3": 300}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntegerValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_10 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_10 + isNullable: true + serializedName: dictionary_getIntegerValid + url: /dictionary/prim/integer/1.-1.3.300 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set dictionary value empty {"0": 1, "1": -1, "2": 3, "3": 300}' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putIntegerValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putIntegerValid + url: /dictionary/prim/integer/1.-1.3.300 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get integer dictionary value {"0": 1, "1": null, "2": 0}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_11 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: dictionary_getIntInvalidNull + url: /dictionary/prim/integer/1.null.zero + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get integer dictionary value {"0": 1, "1": "integer", "2": 0}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_12 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_12 + isNullable: true + serializedName: dictionary_getIntInvalidString + url: /dictionary/prim/integer/1.integer.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get integer dictionary value {"0": 1, "1": -1, "2": 3, "3": 300}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLongValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_13 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: dictionary_getLongValid + url: /dictionary/prim/long/1.-1.3.300 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set dictionary value empty {"0": 1, "1": -1, "2": 3, "3": 300}' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putLongValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putLongValid + url: /dictionary/prim/long/1.-1.3.300 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get long dictionary value {"0": 1, "1": null, "2": 0}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLongInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_14 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: dictionary_getLongInvalidNull + url: /dictionary/prim/long/1.null.zero + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get long dictionary value {"0": 1, "1": "integer", "2": 0}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLongInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_15 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + isNullable: true + returnType: + body: *ref_15 + isNullable: true + serializedName: dictionary_getLongInvalidString + url: /dictionary/prim/long/1.integer.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get float dictionary value {"0": 0, "1": -0.01, "2": 1.2e20}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getFloatValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_16 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_16 + isNullable: true + serializedName: dictionary_getFloatValid + url: /dictionary/prim/float/0--0.01-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set dictionary value {"0": 0, "1": -0.01, "2": 1.2e20}' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putFloatValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putFloatValid + url: /dictionary/prim/float/0--0.01-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get float dictionary value {"0": 0.0, "1": null, "2": 1.2e20}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getFloatInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_17 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_17 + isNullable: true + serializedName: dictionary_getFloatInvalidNull + url: /dictionary/prim/float/0.0-null-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get boolean dictionary value {"0": 1.0, "1": "number", "2": 0.0}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getFloatInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_18 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_18 + isNullable: true + serializedName: dictionary_getFloatInvalidString + url: /dictionary/prim/float/1.number.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get float dictionary value {"0": 0, "1": -0.01, "2": 1.2e20}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDoubleValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_19 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_19 + isNullable: true + serializedName: dictionary_getDoubleValid + url: /dictionary/prim/double/0--0.01-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set dictionary value {"0": 0, "1": -0.01, "2": 1.2e20}' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDoubleValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putDoubleValid + url: /dictionary/prim/double/0--0.01-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get float dictionary value {"0": 0.0, "1": null, "2": 1.2e20}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDoubleInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_20 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_20 + isNullable: true + serializedName: dictionary_getDoubleInvalidNull + url: /dictionary/prim/double/0.0-null-1.2e20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get boolean dictionary value {"0": 1.0, "1": "number", "2": 0.0}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDoubleInvalidString + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_21 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_21 + isNullable: true + serializedName: dictionary_getDoubleInvalidString + url: /dictionary/prim/double/1.number.0 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get string dictionary value {"0": "foo1", "1": "foo2", "2": "foo3"}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getStringValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_22 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_22 + isNullable: true + serializedName: dictionary_getStringValid + url: /dictionary/prim/string/foo1.foo2.foo3 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set dictionary value {"0": "foo1", "1": "foo2", "2": "foo3"}' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putStringValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putStringValid + url: /dictionary/prim/string/foo1.foo2.foo3 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get string dictionary value {"0": "foo", "1": null, "2": "foo2"}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getStringWithNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_23 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_23 + isNullable: true + serializedName: dictionary_getStringWithNull + url: /dictionary/prim/string/foo.null.foo2 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get string dictionary value {"0": "foo", "1": 123, "2": "foo2"}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getStringWithInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_24 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_24 + isNullable: true + serializedName: dictionary_getStringWithInvalid + url: /dictionary/prim/string/foo.123.foo2 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get integer dictionary value {"0": "2000-12-01", "1": "1980-01-02", + "2": "1492-10-12"} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_25 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: dictionary_getDateValid + url: /dictionary/prim/date/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set dictionary value {"0": "2000-12-01", "1": "1980-01-02", "2": + "1492-10-12"} + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDateValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putDateValid + url: /dictionary/prim/date/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get date dictionary value {"0": "2012-01-01", "1": null, "2": + "1776-07-04"} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_26 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + isNullable: true + returnType: + body: *ref_26 + isNullable: true + serializedName: dictionary_getDateInvalidNull + url: /dictionary/prim/date/invalidnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get date dictionary value {"0": "2011-03-22", "1": "date"}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateInvalidChars + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_27 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: dictionary_getDateInvalidChars + url: /dictionary/prim/date/invalidchars + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get date-time dictionary value {"0": "2000-12-01t00:00:01z", "1": + "1980-01-02T00:11:35+01:00", "2": "1492-10-12T10:15:01-08:00"} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTimeValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_28 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_28 + isNullable: true + serializedName: dictionary_getDateTimeValid + url: /dictionary/prim/date-time/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set dictionary value {"0": "2000-12-01t00:00:01z", "1": + "1980-01-02T00:11:35+01:00", "2": "1492-10-12T10:15:01-08:00"} + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDateTimeValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putDateTimeValid + url: /dictionary/prim/date-time/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get date dictionary value {"0": "2000-12-01t00:00:01z", "1": null}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTimeInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_29 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_29 + isNullable: true + serializedName: dictionary_getDateTimeInvalidNull + url: /dictionary/prim/date-time/invalidnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get date dictionary value {"0": "2000-12-01t00:00:01z", "1": + "date-time"} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTimeInvalidChars + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_30 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + isNullable: true + returnType: + body: *ref_30 + isNullable: true + serializedName: dictionary_getDateTimeInvalidChars + url: /dictionary/prim/date-time/invalidchars + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get date-time-rfc1123 dictionary value {"0": "Fri, 01 Dec 2000 + 00:00:01 GMT", "1": "Wed, 02 Jan 1980 00:11:35 GMT", "2": "Wed, 12 Oct + 1492 10:15:01 GMT"} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDateTimeRfc1123Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_31 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + isNullable: true + returnType: + body: *ref_31 + isNullable: true + serializedName: dictionary_getDateTimeRfc1123Valid + url: /dictionary/prim/date-time-rfc1123/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set dictionary value empty {"0": "Fri, 01 Dec 2000 00:00:01 GMT", "1": + "Wed, 02 Jan 1980 00:11:35 GMT", "2": "Wed, 12 Oct 1492 10:15:01 GMT"} + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDateTimeRfc1123Valid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putDateTimeRfc1123Valid + url: /dictionary/prim/date-time-rfc1123/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get duration dictionary value {"0": "P123DT22H14M12.011S", "1": + "P5DT1H0M0S"} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDurationValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_32 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + isNullable: true + returnType: + body: *ref_32 + isNullable: true + serializedName: dictionary_getDurationValid + url: /dictionary/prim/duration/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Set dictionary value {"0": "P123DT22H14M12.011S", "1": "P5DT1H0M0S"}' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDurationValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putDurationValid + url: /dictionary/prim/duration/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get byte dictionary value {"0": hex(FF FF FF FA), "1": hex(01 02 03), + "2": hex (25, 29, 43)} with each item encoded in base64 + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getByteValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_33 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + isNullable: true + returnType: + body: *ref_33 + isNullable: true + serializedName: dictionary_getByteValid + url: /dictionary/prim/byte/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put the dictionary value {"0": hex(FF FF FF FA), "1": hex(01 02 03), + "2": hex (25, 29, 43)} with each elementencoded in base 64 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putByteValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putByteValid + url: /dictionary/prim/byte/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get byte dictionary value {"0": hex(FF FF FF FA), "1": null} with the + first item base64 encoded + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getByteInvalidNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_34 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + isNullable: true + returnType: + body: *ref_34 + isNullable: true + serializedName: dictionary_getByteInvalidNull + url: /dictionary/prim/byte/invalidnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get base64url dictionary value {"0": "a string that gets encoded with + base64url", "1": "test string", "2": "Lorem ipsum"} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBase64Url + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_35 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + isNullable: true + returnType: + body: *ref_35 + isNullable: true + serializedName: dictionary_getBase64Url + url: /dictionary/prim/base64url/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get dictionary of complex type null value + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_37 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_36 + isNullable: true + returnType: + body: *ref_37 + isNullable: true + serializedName: dictionary_getComplexNull + url: /dictionary/complex/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get empty dictionary of complex type {}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_38 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_36 + isNullable: true + returnType: + body: *ref_38 + isNullable: true + serializedName: dictionary_getComplexEmpty + url: /dictionary/complex/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get dictionary of complex type with null item {"0": {"integer": 1, + "string": "2"}, "1": null, "2": {"integer": 5, "string": "6"}} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexItemNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_39 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_36 + isNullable: true + returnType: + body: *ref_39 + isNullable: true + serializedName: dictionary_getComplexItemNull + url: /dictionary/complex/itemnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get dictionary of complex type with empty item {"0": {"integer": 1, + "string": "2"}, "1:" {}, "2": {"integer": 5, "string": "6"}} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexItemEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_40 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_36 + isNullable: true + returnType: + body: *ref_40 + isNullable: true + serializedName: dictionary_getComplexItemEmpty + url: /dictionary/complex/itemempty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get dictionary of complex type with {"0": {"integer": 1, "string": + "2"}, "1": {"integer": 3, "string": "4"}, "2": {"integer": 5, + "string": "6"}} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getComplexValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_41 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_36 + isNullable: true + returnType: + body: *ref_41 + isNullable: true + serializedName: dictionary_getComplexValid + url: /dictionary/complex/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put an dictionary of complex type with values {"0": {"integer": 1, + "string": "2"}, "1": {"integer": 3, "string": "4"}, "2": {"integer": + 5, "string": "6"}} + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putComplexValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_36 + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putComplexValid + url: /dictionary/complex/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a null array + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_42 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_42 + isNullable: true + serializedName: dictionary_getArrayNull + url: /dictionary/array/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get an empty dictionary {}' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_43 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_43 + isNullable: true + serializedName: dictionary_getArrayEmpty + url: /dictionary/array/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an dictionary of array of strings {"0": ["1", "2", "3"], "1": + null, "2": ["7", "8", "9"]} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayItemNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_44 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_44 + isNullable: true + serializedName: dictionary_getArrayItemNull + url: /dictionary/array/itemnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of array of strings [{"0": ["1", "2", "3"], "1": [], "2": + ["7", "8", "9"]} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayItemEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_45 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_45 + isNullable: true + serializedName: dictionary_getArrayItemEmpty + url: /dictionary/array/itemempty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of array of strings {"0": ["1", "2", "3"], "1": ["4", + "5", "6"], "2": ["7", "8", "9"]} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArrayValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_46 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + isNullable: true + returnType: + body: *ref_46 + isNullable: true + serializedName: dictionary_getArrayValid + url: /dictionary/array/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put An array of array of strings {"0": ["1", "2", "3"], "1": ["4", + "5", "6"], "2": ["7", "8", "9"]} + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putArrayValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putArrayValid + url: /dictionary/array/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get an dictionaries of dictionaries with value null + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_47 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_47 + isNullable: true + serializedName: dictionary_getDictionaryNull + url: /dictionary/dictionary/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an dictionaries of dictionaries of type with + value {} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_48 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_48 + isNullable: true + serializedName: dictionary_getDictionaryEmpty + url: /dictionary/dictionary/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an dictionaries of dictionaries of type with + value {"0": {"1": "one", "2": "two", "3": "three"}, "1": null, "2": + {"7": "seven", "8": "eight", "9": "nine"}} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryItemNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_49 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_49 + isNullable: true + serializedName: dictionary_getDictionaryItemNull + url: /dictionary/dictionary/itemnull + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an dictionaries of dictionaries of type with + value {"0": {"1": "one", "2": "two", "3": "three"}, "1": {}, "2": + {"7": "seven", "8": "eight", "9": "nine"}} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryItemEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_50 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_50 + isNullable: true + serializedName: dictionary_getDictionaryItemEmpty + url: /dictionary/dictionary/itemempty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an dictionaries of dictionaries of type with + value {"0": {"1": "one", "2": "two", "3": "three"}, "1": {"4": "four", + "5": "five", "6": "six"}, "2": {"7": "seven", "8": "eight", "9": + "nine"}} + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionaryValid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_51 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_51 + isNullable: true + serializedName: dictionary_getDictionaryValid + url: /dictionary/dictionary/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an dictionaries of dictionaries of type with + value {"0": {"1": "one", "2": "two", "3": "three"}, "1": {"4": "four", + "5": "five", "6": "six"}, "2": {"7": "seven", "8": "eight", "9": + "nine"}} + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: dictionary + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDictionaryValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: arrayBody + isConstant: false + isRequired: true + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: arrayBody + serializedName: arrayBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: dictionary_putDictionaryValid + url: /dictionary/dictionary/valid + name: + fixed: false + raw: Dictionary + nameForProperty: Dictionary + typeName: + fixed: false diff --git a/test/Expected/body-duration/code-model-v1-yaml.yaml b/test/Expected/body-duration/code-model-v1-yaml.yaml new file mode 100644 index 0000000..595a2da --- /dev/null +++ b/test/Expected/body-duration/code-model-v1-yaml.yaml @@ -0,0 +1,211 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'https://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestDurationTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null duration value + group: + fixed: false + raw: duration + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: duration_getNull + url: /duration/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put a positive duration value + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: duration + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putPositiveDuration + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: durationBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: durationBody + serializedName: durationBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: duration_putPositiveDuration + url: /duration/positiveduration + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a positive duration value + group: + fixed: false + raw: duration + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getPositiveDuration + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: duration_getPositiveDuration + url: /duration/positiveduration + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get an invalid duration value + group: + fixed: false + raw: duration + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: duration_getInvalid + url: /duration/invalid + name: + fixed: false + raw: Duration + nameForProperty: Duration + typeName: + fixed: false diff --git a/test/Expected/body-file/code-model-v1-yaml.yaml b/test/Expected/body-file/code-model-v1-yaml.yaml new file mode 100644 index 0000000..52c5f94 --- /dev/null +++ b/test/Expected/body-file/code-model-v1-yaml.yaml @@ -0,0 +1,163 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest Swagger BAT +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestSwaggerBATFileService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get file + group: + fixed: false + raw: files + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetFile + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - image/png + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: files_GetFile + url: /files/stream/nonempty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a large file + group: + fixed: false + raw: files + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetFileLarge + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - image/png + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: files_GetFileLarge + url: /files/stream/verylarge + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get empty file + group: + fixed: false + raw: files + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetEmptyFile + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - image/png + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: files_GetEmptyFile + url: /files/stream/empty + name: + fixed: false + raw: Files + nameForProperty: Files + typeName: + fixed: false diff --git a/test/Expected/body-formdata-urlencoded/code-model-v1-yaml.yaml b/test/Expected/body-formdata-urlencoded/code-model-v1-yaml.yaml new file mode 100644 index 0000000..e56e579 --- /dev/null +++ b/test/Expected/body-formdata-urlencoded/code-model-v1-yaml.yaml @@ -0,0 +1,101 @@ +--- +apiVersion: 1.0.0 +baseUrl: '' +documentation: Test Infrastructure for AutoRest Swagger BAT +modelsName: Models +name: AutoRestSwaggerBATFormDataService +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: '' + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: updatePetWithForm + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of pet that needs to be updated + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: petId + serializedName: petId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Updated name of the pet + isConstant: false + isRequired: false + location: formData + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Updated status of the pet + isConstant: false + isRequired: false + location: formData + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: status + serializedName: status + requestContentType: application/x-www-form-urlencoded + responseContentTypes: + - application/json + responses: + MethodNotAllowed: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: updatePetWithForm + summary: Updates a pet in the store with form data + url: / + name: + fixed: false + raw: '' + nameForProperty: AutoRestSwaggerBATFormDataService + typeName: + fixed: false diff --git a/test/Expected/body-formdata/code-model-v1-yaml.yaml b/test/Expected/body-formdata/code-model-v1-yaml.yaml new file mode 100644 index 0000000..a7835b4 --- /dev/null +++ b/test/Expected/body-formdata/code-model-v1-yaml.yaml @@ -0,0 +1,198 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest Swagger BAT +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestSwaggerBATFormDataService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Upload file + extensions: + x-ms-requestBody-index: '1' + group: + fixed: false + raw: formdata + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: UploadFile + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: File to upload. + isConstant: false + isRequired: true + location: formData + modelType: + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + name: + fixed: false + raw: fileContent + serializedName: fileContent + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + File name to upload. Name has to be spelled exactly as written + here. + isConstant: false + isRequired: true + location: formData + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: fileName + serializedName: fileName + requestContentType: multipart/form-data + responseContentTypes: + - application/octet-stream + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: formdata_UploadFile + url: /formdata/stream/uploadfile + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Upload file + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: formdata + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UploadFileViaBody + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: File to upload. + extensions: + x-ms-requestBody-name: fileContent + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + name: + fixed: false + raw: fileContent + serializedName: fileContent + requestContentType: application/octet-stream + responseContentTypes: + - application/octet-stream + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: formdata_UploadFileViaBody + url: /formdata/stream/uploadfile + name: + fixed: false + raw: Formdata + nameForProperty: Formdata + typeName: + fixed: false diff --git a/test/Expected/body-integer/code-model-v1-yaml.yaml b/test/Expected/body-integer/code-model-v1-yaml.yaml new file mode 100644 index 0000000..cc17657 --- /dev/null +++ b/test/Expected/body-integer/code-model-v1-yaml.yaml @@ -0,0 +1,593 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestIntegerTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null Int value + group: + fixed: false + raw: int + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: int_getNull + url: /int/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid Int value + group: + fixed: false + raw: int + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: int_getInvalid + url: /int/invalid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get overflow Int32 value + group: + fixed: false + raw: int + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getOverflowInt32 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: int_getOverflowInt32 + url: /int/overflowint32 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get underflow Int32 value + group: + fixed: false + raw: int + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUnderflowInt32 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: int_getUnderflowInt32 + url: /int/underflowint32 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get overflow Int64 value + group: + fixed: false + raw: int + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getOverflowInt64 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: int_getOverflowInt64 + url: /int/overflowint64 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get underflow Int64 value + group: + fixed: false + raw: int + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUnderflowInt64 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: int_getUnderflowInt64 + url: /int/underflowint64 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put max int32 value + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: int + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putMax32 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: intBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: intBody + serializedName: intBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: int_putMax32 + url: /int/max/32 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put max int64 value + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: int + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putMax64 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: intBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: intBody + serializedName: intBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: int_putMax64 + url: /int/max/64 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put min int32 value + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: int + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putMin32 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: intBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: intBody + serializedName: intBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: int_putMin32 + url: /int/min/32 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put min int64 value + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: int + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putMin64 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: intBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: intBody + serializedName: intBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: int_putMin64 + url: /int/min/64 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get datetime encoded as Unix time value + group: + fixed: false + raw: int + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getUnixTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_7 + $type: PrimaryType + format: unixtime + knownPrimaryType: unixTime + name: + fixed: false + raw: UnixTime + isNullable: true + returnType: + body: *ref_7 + isNullable: true + serializedName: int_getUnixTime + url: /int/unixtime + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put datetime encoded as Unix time + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: int + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putUnixTimeDate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: intBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: unixtime + knownPrimaryType: unixTime + name: + fixed: false + raw: UnixTime + name: + fixed: false + raw: intBody + serializedName: intBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: int_putUnixTimeDate + url: /int/unixtime + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid Unix time value + group: + fixed: false + raw: int + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalidUnixTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_8 + $type: PrimaryType + format: unixtime + knownPrimaryType: unixTime + name: + fixed: false + raw: UnixTime + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: int_getInvalidUnixTime + url: /int/invalidunixtime + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null Unix time value + group: + fixed: false + raw: int + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNullUnixTime + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_9 + $type: PrimaryType + format: unixtime + knownPrimaryType: unixTime + name: + fixed: false + raw: UnixTime + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: int_getNullUnixTime + url: /int/nullunixtime + name: + fixed: false + raw: Int + nameForProperty: Int + typeName: + fixed: false diff --git a/test/Expected/body-number.quirks/code-model-v1-yaml.yaml b/test/Expected/body-number.quirks/code-model-v1-yaml.yaml new file mode 100644 index 0000000..27bfb6a --- /dev/null +++ b/test/Expected/body-number.quirks/code-model-v1-yaml.yaml @@ -0,0 +1,994 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'https://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestNumberTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null Number value + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: number_getNull + url: /number/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid float Number value + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalidFloat + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: number_getInvalidFloat + url: /number/invalidfloat + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid double Number value + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalidDouble + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: number_getInvalidDouble + url: /number/invaliddouble + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid decimal Number value + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalidDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: number_getInvalidDecimal + url: /number/invaliddecimal + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big float value 3.402823e+20 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigFloat + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigFloat + url: /number/big/float/3.402823e+20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big float value 3.402823e+20 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigFloat + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: number_getBigFloat + url: /number/big/float/3.402823e+20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big double value 2.5976931e+101 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDouble + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDouble + url: /number/big/double/2.5976931e+101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value 2.5976931e+101 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDouble + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: number_getBigDouble + url: /number/big/double/2.5976931e+101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big double value 99999999.99 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDoublePositiveDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDoublePositiveDecimal + url: /number/big/double/99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value 99999999.99 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDoublePositiveDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_7 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_7 + isNullable: true + serializedName: number_getBigDoublePositiveDecimal + url: /number/big/double/99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big double value -99999999.99 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDoubleNegativeDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDoubleNegativeDecimal + url: /number/big/double/-99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value -99999999.99 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDoubleNegativeDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_8 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: number_getBigDoubleNegativeDecimal + url: /number/big/double/-99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big decimal value 2.5976931e+101 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDecimal + url: /number/big/decimal/2.5976931e+101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big decimal value 2.5976931e+101 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_9 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: number_getBigDecimal + url: /number/big/decimal/2.5976931e+101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big decimal value 99999999.99 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDecimalPositiveDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDecimalPositiveDecimal + url: /number/big/decimal/99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big decimal value 99999999.99 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDecimalPositiveDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_10 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_10 + isNullable: true + serializedName: number_getBigDecimalPositiveDecimal + url: /number/big/decimal/99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big decimal value -99999999.99 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDecimalNegativeDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDecimalNegativeDecimal + url: /number/big/decimal/-99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big decimal value -99999999.99 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDecimalNegativeDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_11 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: number_getBigDecimalNegativeDecimal + url: /number/big/decimal/-99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put small float value 3.402823e-20 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putSmallFloat + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putSmallFloat + url: /number/small/float/3.402823e-20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value 3.402823e-20 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSmallFloat + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_12 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_12 + isNullable: true + serializedName: number_getSmallFloat + url: /number/small/float/3.402823e-20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put small double value 2.5976931e-101 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putSmallDouble + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putSmallDouble + url: /number/small/double/2.5976931e-101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value 2.5976931e-101 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSmallDouble + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_13 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: number_getSmallDouble + url: /number/small/double/2.5976931e-101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put small decimal value 2.5976931e-101 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putSmallDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putSmallDecimal + url: /number/small/decimal/2.5976931e-101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get small decimal value 2.5976931e-101 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSmallDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_14 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: number_getSmallDecimal + url: /number/small/decimal/2.5976931e-101 + name: + fixed: false + raw: Number + nameForProperty: Number + typeName: + fixed: false diff --git a/test/Expected/body-number/code-model-v1-yaml.yaml b/test/Expected/body-number/code-model-v1-yaml.yaml new file mode 100644 index 0000000..c80aae9 --- /dev/null +++ b/test/Expected/body-number/code-model-v1-yaml.yaml @@ -0,0 +1,998 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'https://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestNumberTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null Number value + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: PrimaryType + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: number_getNull + url: /number/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid float Number value + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalidFloat + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: number_getInvalidFloat + url: /number/invalidfloat + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid double Number value + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalidDouble + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: number_getInvalidDouble + url: /number/invaliddouble + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get invalid decimal Number value + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getInvalidDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: number_getInvalidDecimal + url: /number/invaliddecimal + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big float value 3.402823e+20 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigFloat + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigFloat + url: /number/big/float/3.402823e+20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big float value 3.402823e+20 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigFloat + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: number_getBigFloat + url: /number/big/float/3.402823e+20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big double value 2.5976931e+101 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDouble + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDouble + url: /number/big/double/2.5976931e+101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value 2.5976931e+101 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDouble + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: number_getBigDouble + url: /number/big/double/2.5976931e+101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big double value 99999999.99 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDoublePositiveDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '99999999.99' + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: true + isRequired: true + location: body + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDoublePositiveDecimal + url: /number/big/double/99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value 99999999.99 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDoublePositiveDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_7 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_7 + isNullable: true + serializedName: number_getBigDoublePositiveDecimal + url: /number/big/double/99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big double value -99999999.99 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDoubleNegativeDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-99999999.99' + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: true + isRequired: true + location: body + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDoubleNegativeDecimal + url: /number/big/double/-99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value -99999999.99 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDoubleNegativeDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_8 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: number_getBigDoubleNegativeDecimal + url: /number/big/double/-99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big decimal value 2.5976931e+101 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDecimal + url: /number/big/decimal/2.5976931e+101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big decimal value 2.5976931e+101 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_9 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: number_getBigDecimal + url: /number/big/decimal/2.5976931e+101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big decimal value 99999999.99 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDecimalPositiveDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '99999999.99' + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: true + isRequired: true + location: body + modelType: + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDecimalPositiveDecimal + url: /number/big/decimal/99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big decimal value 99999999.99 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDecimalPositiveDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_10 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_10 + isNullable: true + serializedName: number_getBigDecimalPositiveDecimal + url: /number/big/decimal/99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put big decimal value -99999999.99 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBigDecimalNegativeDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-99999999.99' + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: true + isRequired: true + location: body + modelType: + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putBigDecimalNegativeDecimal + url: /number/big/decimal/-99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big decimal value -99999999.99 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBigDecimalNegativeDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_11 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: number_getBigDecimalNegativeDecimal + url: /number/big/decimal/-99999999.99 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put small float value 3.402823e-20 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putSmallFloat + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putSmallFloat + url: /number/small/float/3.402823e-20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value 3.402823e-20 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSmallFloat + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_12 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_12 + isNullable: true + serializedName: number_getSmallFloat + url: /number/small/float/3.402823e-20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put small double value 2.5976931e-101 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putSmallDouble + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putSmallDouble + url: /number/small/double/2.5976931e-101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get big double value 2.5976931e-101 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSmallDouble + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_13 + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: number_getSmallDouble + url: /number/small/double/2.5976931e-101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put small decimal value 2.5976931e-101 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: number + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putSmallDecimal + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: numberBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + name: + fixed: false + raw: numberBody + serializedName: numberBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: number_putSmallDecimal + url: /number/small/decimal/2.5976931e-101 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get small decimal value 2.5976931e-101 + group: + fixed: false + raw: number + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSmallDecimal + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_14 + $type: PrimaryType + format: decimal + knownPrimaryType: decimal + name: + fixed: false + raw: Decimal + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: number_getSmallDecimal + url: /number/small/decimal/2.5976931e-101 + name: + fixed: false + raw: Number + nameForProperty: Number + typeName: + fixed: false diff --git a/test/Expected/body-string.quirks/code-model-v1-yaml.yaml b/test/Expected/body-string.quirks/code-model-v1-yaml.yaml new file mode 100644 index 0000000..894c011 --- /dev/null +++ b/test/Expected/body-string.quirks/code-model-v1-yaml.yaml @@ -0,0 +1,900 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest Swagger BAT +enumTypes: + - &ref_9 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: Colors + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: red color + serializedName: red color + - name: green-color + serializedName: green-color + - name: blue_color + serializedName: blue_color +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 + - &ref_10 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: RefColorConstant + properties: + - collectionFormat: none + defaultValue: + fixed: false + raw: green-color + documentation: + fixed: false + raw: Referenced Color Constant Description. + extensions: + x-ms-enum: + modelAsString: false + name: ColorConstant + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ColorConstant + realPath: + - ColorConstant + serializedName: ColorConstant + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sample string. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: field1 + realPath: + - field1 + serializedName: field1 + serializedName: RefColorConstant +modelsName: Models +name: AutoRestSwaggerBATService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null string value value + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - {} + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: string_getNull + url: /string/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Set string value null + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putNull + url: /string/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get empty string value value '' + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: '' + serializedName: '' + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: string_getEmpty + url: /string/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Set string value empty '' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putEmpty + url: /string/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get mbcs string value + '啊齄丂狛狜隣郎隣兀﨩ˊ〞〡￤℡㈱‐ー﹡﹢﹫、〓ⅰⅹ⒈€㈠㈩ⅠⅫ！￣ぁんァヶΑ︴АЯаяāɡㄅㄩ─╋︵﹄︻︱︳︴ⅰⅹɑɡ〇〾⿻⺁䜣€' + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMbcs + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: >- + 啊齄丂狛狜隣郎隣兀﨩ˊ〞〡￤℡㈱‐ー﹡﹢﹫、〓ⅰⅹ⒈€㈠㈩ⅠⅫ！￣ぁんァヶΑ︴АЯаяāɡㄅㄩ─╋︵﹄︻︱︳︴ⅰⅹɑɡ〇〾⿻⺁䜣€ + serializedName: >- + 啊齄丂狛狜隣郎隣兀﨩ˊ〞〡￤℡㈱‐ー﹡﹢﹫、〓ⅰⅹ⒈€㈠㈩ⅠⅫ！￣ぁんァヶΑ︴АЯаяāɡㄅㄩ─╋︵﹄︻︱︳︴ⅰⅹɑɡ〇〾⿻⺁䜣€ + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: string_getMbcs + url: /string/mbcs + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set string value mbcs + '啊齄丂狛狜隣郎隣兀﨩ˊ〞〡￤℡㈱‐ー﹡﹢﹫、〓ⅰⅹ⒈€㈠㈩ⅠⅫ！￣ぁんァヶΑ︴АЯаяāɡㄅㄩ─╋︵﹄︻︱︳︴ⅰⅹɑɡ〇〾⿻⺁䜣€' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putMbcs + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putMbcs + url: /string/mbcs + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get string value with leading and trailing whitespace + 'Now is the time for all good men to come to the + aid of their country' + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getWhitespace + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: ' Now is the time for all good men to come to the aid of their country ' + serializedName: ' Now is the time for all good men to come to the aid of their country ' + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: string_getWhitespace + url: /string/whitespace + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set String value with leading and trailing whitespace + 'Now is the time for all good men to come to the + aid of their country' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putWhitespace + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putWhitespace + url: /string/whitespace + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get String value when no string value is sent in response payload + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNotProvided + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: string_getNotProvided + url: /string/notProvided + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get value that is base64 encoded + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBase64Encoded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: string_getBase64Encoded + url: /string/base64Encoding + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get value that is base64url encoded + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBase64UrlEncoded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_7 + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + isNullable: true + returnType: + body: *ref_7 + isNullable: true + serializedName: string_getBase64UrlEncoded + url: /string/base64UrlEncoding + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put value that is base64url encoded + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBase64UrlEncoded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putBase64UrlEncoded + url: /string/base64UrlEncoding + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null value that is expected to be base64url encoded + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNullBase64UrlEncoded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_8 + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: string_getNullBase64UrlEncoded + url: /string/nullBase64UrlEncoding + name: + fixed: false + raw: String + nameForProperty: String + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get enum value 'red color' from enumeration of 'red color', + 'green-color', 'blue_color'. + group: + fixed: false + raw: enum + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNotExpandable + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_9 + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: enum_getNotExpandable + url: /string/enum/notExpandable + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Sends value 'red color' from enumeration of 'red color', + 'green-color', 'blue_color' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: enum + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNotExpandable + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: false + isRequired: true + location: body + modelType: *ref_9 + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: enum_putNotExpandable + url: /string/enum/notExpandable + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get enum value 'red color' from enumeration of 'red color', + 'green-color', 'blue_color'. + group: + fixed: false + raw: enum + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getReferenced + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_9 + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: enum_getReferenced + url: /string/enum/Referenced + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Sends value 'red color' from enumeration of 'red color', + 'green-color', 'blue_color' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: enum + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putReferenced + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: enumStringBody + isConstant: false + isRequired: true + location: body + modelType: *ref_9 + name: + fixed: false + raw: enumStringBody + serializedName: enumStringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: enum_putReferenced + url: /string/enum/Referenced + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get value 'green-color' from the constant. + group: + fixed: false + raw: enum + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getReferencedConstant + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_10 + isNullable: true + returnType: + body: *ref_10 + isNullable: true + serializedName: enum_getReferencedConstant + url: /string/enum/ReferencedConstant + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Sends value 'green-color' from a constant + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: enum + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putReferencedConstant + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: enumStringBody + isConstant: false + isRequired: true + location: body + modelType: *ref_10 + name: + fixed: false + raw: enumStringBody + serializedName: enumStringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: enum_putReferencedConstant + url: /string/enum/ReferencedConstant + name: + fixed: false + raw: Enum + nameForProperty: Enum + typeName: + fixed: false diff --git a/test/Expected/body-string/code-model-v1-yaml.yaml b/test/Expected/body-string/code-model-v1-yaml.yaml new file mode 100644 index 0000000..520b5c4 --- /dev/null +++ b/test/Expected/body-string/code-model-v1-yaml.yaml @@ -0,0 +1,913 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest Swagger BAT +enumTypes: + - &ref_9 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: Colors + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: red color + serializedName: red color + - name: green-color + serializedName: green-color + - name: blue_color + serializedName: blue_color +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 + - &ref_10 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: RefColorConstant + properties: + - collectionFormat: none + defaultValue: + fixed: false + raw: green-color + documentation: + fixed: false + raw: Referenced Color Constant Description. + extensions: + x-ms-enum: + modelAsString: false + name: ColorConstant + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ColorConstant + realPath: + - ColorConstant + serializedName: ColorConstant + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sample string. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: field1 + realPath: + - field1 + serializedName: field1 + serializedName: RefColorConstant +modelsName: Models +name: AutoRestSwaggerBATService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null string value value + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNull + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - {} + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: string_getNull + url: /string/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Set string value null + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: false + isRequired: false + location: body + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - {} + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putNull + url: /string/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get empty string value value '' + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: '' + serializedName: '' + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: string_getEmpty + url: /string/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Set string value empty '' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '' + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: true + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putEmpty + url: /string/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get mbcs string value + '啊齄丂狛狜隣郎隣兀﨩ˊ〞〡￤℡㈱‐ー﹡﹢﹫、〓ⅰⅹ⒈€㈠㈩ⅠⅫ！￣ぁんァヶΑ︴АЯаяāɡㄅㄩ─╋︵﹄︻︱︳︴ⅰⅹɑɡ〇〾⿻⺁䜣€' + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMbcs + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: >- + 啊齄丂狛狜隣郎隣兀﨩ˊ〞〡￤℡㈱‐ー﹡﹢﹫、〓ⅰⅹ⒈€㈠㈩ⅠⅫ！￣ぁんァヶΑ︴АЯаяāɡㄅㄩ─╋︵﹄︻︱︳︴ⅰⅹɑɡ〇〾⿻⺁䜣€ + serializedName: >- + 啊齄丂狛狜隣郎隣兀﨩ˊ〞〡￤℡㈱‐ー﹡﹢﹫、〓ⅰⅹ⒈€㈠㈩ⅠⅫ！￣ぁんァヶΑ︴АЯаяāɡㄅㄩ─╋︵﹄︻︱︳︴ⅰⅹɑɡ〇〾⿻⺁䜣€ + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: string_getMbcs + url: /string/mbcs + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set string value mbcs + '啊齄丂狛狜隣郎隣兀﨩ˊ〞〡￤℡㈱‐ー﹡﹢﹫、〓ⅰⅹ⒈€㈠㈩ⅠⅫ！￣ぁんァヶΑ︴АЯаяāɡㄅㄩ─╋︵﹄︻︱︳︴ⅰⅹɑɡ〇〾⿻⺁䜣€' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putMbcs + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: >- + 啊齄丂狛狜隣郎隣兀﨩ˊ〞〡￤℡㈱‐ー﹡﹢﹫、〓ⅰⅹ⒈€㈠㈩ⅠⅫ！￣ぁんァヶΑ︴АЯаяāɡㄅㄩ─╋︵﹄︻︱︳︴ⅰⅹɑɡ〇〾⿻⺁䜣€ + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: true + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putMbcs + url: /string/mbcs + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get string value with leading and trailing whitespace + 'Now is the time for all good men to come to the + aid of their country' + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getWhitespace + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: ' Now is the time for all good men to come to the aid of their country ' + serializedName: ' Now is the time for all good men to come to the aid of their country ' + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: string_getWhitespace + url: /string/whitespace + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Set String value with leading and trailing whitespace + 'Now is the time for all good men to come to the + aid of their country' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putWhitespace + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: ' Now is the time for all good men to come to the aid of their country ' + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: true + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putWhitespace + url: /string/whitespace + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get String value when no string value is sent in response payload + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNotProvided + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: string_getNotProvided + url: /string/notProvided + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get value that is base64 encoded + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBase64Encoded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_6 + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: string_getBase64Encoded + url: /string/base64Encoding + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get value that is base64url encoded + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBase64UrlEncoded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_7 + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + isNullable: true + returnType: + body: *ref_7 + isNullable: true + serializedName: string_getBase64UrlEncoded + url: /string/base64UrlEncoding + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put value that is base64url encoded + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: string + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putBase64UrlEncoded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: string_putBase64UrlEncoded + url: /string/base64UrlEncoding + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null value that is expected to be base64url encoded + group: + fixed: false + raw: string + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNullBase64UrlEncoded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_8 + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: string_getNullBase64UrlEncoded + url: /string/nullBase64UrlEncoding + name: + fixed: false + raw: String + nameForProperty: String + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get enum value 'red color' from enumeration of 'red color', + 'green-color', 'blue_color'. + group: + fixed: false + raw: enum + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNotExpandable + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_9 + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: enum_getNotExpandable + url: /string/enum/notExpandable + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Sends value 'red color' from enumeration of 'red color', + 'green-color', 'blue_color' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: enum + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNotExpandable + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: stringBody + isConstant: false + isRequired: true + location: body + modelType: *ref_9 + name: + fixed: false + raw: stringBody + serializedName: stringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: enum_putNotExpandable + url: /string/enum/notExpandable + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get enum value 'red color' from enumeration of 'red color', + 'green-color', 'blue_color'. + group: + fixed: false + raw: enum + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getReferenced + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_9 + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: enum_getReferenced + url: /string/enum/Referenced + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Sends value 'red color' from enumeration of 'red color', + 'green-color', 'blue_color' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: enum + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putReferenced + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: enumStringBody + isConstant: false + isRequired: true + location: body + modelType: *ref_9 + name: + fixed: false + raw: enumStringBody + serializedName: enumStringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: enum_putReferenced + url: /string/enum/Referenced + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get value 'green-color' from the constant. + group: + fixed: false + raw: enum + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getReferencedConstant + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_10 + isNullable: true + returnType: + body: *ref_10 + isNullable: true + serializedName: enum_getReferencedConstant + url: /string/enum/ReferencedConstant + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Sends value 'green-color' from a constant + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: enum + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putReferencedConstant + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: enumStringBody + isConstant: false + isRequired: true + location: body + modelType: *ref_10 + name: + fixed: false + raw: enumStringBody + serializedName: enumStringBody + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: enum_putReferencedConstant + url: /string/enum/ReferencedConstant + name: + fixed: false + raw: Enum + nameForProperty: Enum + typeName: + fixed: false diff --git a/test/Expected/complex-model/code-model-v1-yaml.yaml b/test/Expected/complex-model/code-model-v1-yaml.yaml new file mode 100644 index 0000000..2d0f00b --- /dev/null +++ b/test/Expected/complex-model/code-model-v1-yaml.yaml @@ -0,0 +1,661 @@ +--- +apiVersion: 2014-04-01-preview +baseUrl: 'http://localhost' +documentation: Some cool documentation. +errorTypes: + - &ref_1 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + documentation: The product documentation. + name: + fixed: false + raw: Product + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unique identifier representing a specific product for a given + latitude & longitude. For example, uberX in San Francisco will have + a different product_id than uberX in Los Angeles. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: product_id + realPath: + - product_id + serializedName: product_id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Description of product. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Display name of product. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: display_name + realPath: + - display_name + serializedName: display_name + - collectionFormat: none + defaultValue: + fixed: false + raw: '100' + documentation: + fixed: false + raw: 'Capacity of product. For example, 4 people.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: capacity + realPath: + - capacity + serializedName: capacity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Image URL representing the product. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: image + realPath: + - image + serializedName: image + serializedName: Product + - &ref_5 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CatalogDictionary + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Dictionary of products + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_0 + name: + fixed: false + raw: productDictionary + realPath: + - productDictionary + serializedName: productDictionary + serializedName: CatalogDictionary + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CatalogArray + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Array of products + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_0 + name: + fixed: false + name: + fixed: false + raw: productArray + realPath: + - productArray + serializedName: productArray + serializedName: CatalogArray + - &ref_6 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CatalogArrayOfDictionary + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Array of dictionary of products + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_0 + name: + fixed: false + name: + fixed: false + raw: productArrayOfDictionary + realPath: + - productArrayOfDictionary + serializedName: productArrayOfDictionary + serializedName: CatalogArrayOfDictionary + - &ref_3 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CatalogDictionaryOfArray + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Dictionary of Array of product + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: SequenceType + elementType: *ref_0 + name: + fixed: false + name: + fixed: false + raw: productDictionaryOfArray + realPath: + - productDictionaryOfArray + serializedName: productDictionaryOfArray + serializedName: CatalogDictionaryOfArray + - *ref_1 +modelsName: Models +name: ComplexModelClient +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + The Products endpoint returns information about the Uber products + offered at a given location. The response includes the display name + and other details about each product, and lists the products in the + proper display order. + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: list + parameters: + - clientProperty: &ref_7 + collectionFormat: none + defaultValue: + fixed: false + raw: '123456' + documentation: + fixed: false + raw: Subscription ID. + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + collectionFormat: none + defaultValue: + fixed: false + raw: '123456' + documentation: + fixed: false + raw: Subscription ID. + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Group ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: &ref_4 + collectionFormat: none + defaultValue: + fixed: false + raw: 2014-04-01-preview + documentation: + fixed: false + raw: API ID. + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + raw: 2014-04-01-preview + documentation: + fixed: false + raw: API ID. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: list + summary: Product Types + url: >- + /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/Microsoft.Cache/Redis + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Resets products. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: '' + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: create + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Subscription ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Group ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: body Parameter + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_3 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + - clientProperty: *ref_4 + collectionFormat: none + defaultValue: + fixed: false + raw: 2014-04-01-preview + documentation: + fixed: false + raw: API ID. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_5 + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: create + summary: Create products + url: >- + /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/Microsoft.Cache/Redis + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Resets products. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: update + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Subscription ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Group ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: body Parameter + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_6 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + - clientProperty: *ref_4 + collectionFormat: none + defaultValue: + fixed: false + raw: 2014-04-01-preview + documentation: + fixed: false + raw: API ID. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: update + summary: Update products + url: >- + /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/Microsoft.Cache/Redis + name: + fixed: false + raw: '' + nameForProperty: ComplexModelClient + typeName: + fixed: false +properties: + - *ref_7 + - *ref_4 diff --git a/test/Expected/custom-baseUrl-more-options/code-model-v1-yaml.yaml b/test/Expected/custom-baseUrl-more-options/code-model-v1-yaml.yaml new file mode 100644 index 0000000..6232860 --- /dev/null +++ b/test/Expected/custom-baseUrl-more-options/code-model-v1-yaml.yaml @@ -0,0 +1,304 @@ +--- +apiVersion: 1.0.0 +baseUrl: '{vault}{secret}{dnsSuffix}' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +extensions: + x-ms-parameterized-host: + hostTemplate: '{vault}{secret}{dnsSuffix}' + parameters: + - description: 'The vault name, e.g. https://myvault' + in: path + name: vault + required: true + schema: + description: 'The vault name, e.g. https://myvault' + in: path + name: vault + type: string + x-ms-skip-url-encoding: true + type: string + x-ms-skip-url-encoding: true + - description: Secret value. + in: path + name: secret + required: true + schema: + description: Secret value. + in: path + name: secret + type: string + x-ms-skip-url-encoding: true + type: string + x-ms-skip-url-encoding: true + - $ref: '#/components/parameters/dnsSuffix' + useSchemePrefix: false +hostParametersFront: + - clientProperty: &ref_2 + collectionFormat: none + defaultValue: + fixed: false + raw: host + documentation: + fixed: false + raw: >- + A string value that is used as a global part of the parameterized + host. Default value 'host'. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: dnsSuffix + realPath: + - dnsSuffix + serializedName: dnsSuffix + collectionFormat: none + defaultValue: + fixed: false + raw: host + documentation: + fixed: false + raw: >- + A string value that is used as a global part of the parameterized host. + Default value 'host'. + extensions: + hostParameter: true + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: dnsSuffix + serializedName: dnsSuffix + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Secret value. + extensions: + hostParameter: true + type: string + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: secret + serializedName: secret + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The vault name, e.g. https://myvault' + extensions: + hostParameter: true + type: string + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vault + serializedName: vault +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestParameterizedCustomHostTestClient +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a 200 to test a valid base uri + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The key name with value 'key1'. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: keyName + serializedName: keyName + - clientProperty: &ref_1 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The subscription id with value 'test12'. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The subscription id with value 'test12'. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - collectionFormat: none + defaultValue: + fixed: false + raw: v1 + documentation: + fixed: false + raw: The key version. Default value 'v1'. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: keyVersion + serializedName: keyVersion + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_getEmpty + url: '/customuri/{subscriptionId}/{keyName}' + name: + fixed: false + raw: Paths + nameForProperty: Paths + typeName: + fixed: false +properties: + - *ref_1 + - *ref_2 diff --git a/test/Expected/custom-baseUrl/code-model-v1-yaml.yaml b/test/Expected/custom-baseUrl/code-model-v1-yaml.yaml new file mode 100644 index 0000000..98f1ff0 --- /dev/null +++ b/test/Expected/custom-baseUrl/code-model-v1-yaml.yaml @@ -0,0 +1,183 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://{accountName}{host}' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +extensions: + x-ms-parameterized-host: + hostTemplate: 'http://{accountName}{host}' + parameters: + - description: Account Name + in: path + name: accountName + required: true + schema: + description: Account Name + in: path + name: accountName + type: string + x-ms-skip-url-encoding: true + type: string + x-ms-skip-url-encoding: true + - $ref: '#/components/parameters/host' + positionInOperation: last +hostParametersBack: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Account Name + extensions: + hostParameter: true + type: string + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: accountName + serializedName: accountName + - clientProperty: &ref_1 + collectionFormat: none + defaultValue: + fixed: false + raw: host + documentation: + fixed: false + raw: A string value that is used as a global part of the parameterized host + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: host + realPath: + - host + serializedName: host + collectionFormat: none + defaultValue: + fixed: false + raw: host + documentation: + fixed: false + raw: A string value that is used as a global part of the parameterized host + extensions: + hostParameter: true + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: host + serializedName: host +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestParameterizedHostTestClient +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a 200 to test a valid base uri + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_getEmpty + url: /customuri + name: + fixed: false + raw: Paths + nameForProperty: Paths + typeName: + fixed: false +properties: + - *ref_1 diff --git a/test/Expected/extensible-enums-swagger/code-model-v1-yaml.yaml b/test/Expected/extensible-enums-swagger/code-model-v1-yaml.yaml new file mode 100644 index 0000000..f16b00e --- /dev/null +++ b/test/Expected/extensible-enums-swagger/code-model-v1-yaml.yaml @@ -0,0 +1,281 @@ +--- +apiVersion: '2016-07-07' +baseUrl: 'https://localhost' +documentation: PetStore +enumTypes: + - &ref_0 + $type: EnumType + modelAsExtensible: true + modelAsString: false + name: + fixed: false + raw: DaysOfWeekExtensibleEnum + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Monday + serializedName: Monday + - name: Tuesday + serializedName: Tuesday + - name: Wednesday + serializedName: Wednesday + - name: Thursday + serializedName: Thursday + - name: Friday + serializedName: Friday + - name: Saturday + serializedName: Saturday + - name: Sunday + serializedName: Sunday + - &ref_1 + $type: EnumType + modelAsExtensible: true + modelAsString: false + name: + fixed: false + raw: IntEnum + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - allowedValues: + - '1.1' + - '1.2' + - '1.3' + description: one + name: '1' + serializedName: '1' + - allowedValues: + - '2.1' + - '2.2' + description: two + name: '2' + serializedName: '2' + - allowedValues: + - '3.1' + - '3.3' + description: three + name: '3' + serializedName: '3' +modelTypes: + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Pet + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + raw: Friday + documentation: + fixed: false + raw: Type of Pet + extensions: + x-ms-enum: + modelAsExtensible: true + name: DaysOfWeekExtensibleEnum + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: DaysOfWeek + realPath: + - DaysOfWeek + serializedName: DaysOfWeek + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: '' + extensions: + x-ms-enum: + modelAsExtensible: true + name: IntEnum + values: + - allowedValues: + - '1.1' + - '1.2' + - '1.3' + description: one + name: '1' + value: '1' + - allowedValues: + - '2.1' + - '2.2' + description: two + name: '2' + value: '2' + - allowedValues: + - '3.1' + - '3.3' + description: three + name: '3' + value: '3' + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_1 + name: + fixed: false + raw: IntEnum + realPath: + - IntEnum + serializedName: IntEnum + serializedName: Pet +modelsName: Models +name: PetStoreInc +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + group: + fixed: false + raw: Pet + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetByPetId + parameters: + - clientProperty: &ref_3 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Pet id + extensions: + x-ms-parameter-location: method + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: petId + realPath: + - petId + serializedName: petId + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Pet id + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: petId + serializedName: petId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Pet_GetByPetId + url: '/extensibleenums/pet/{petId}' + - defaultResponse: + isNullable: true + deprecated: false + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: Pet + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: AddPet + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: petParam + isConstant: false + isRequired: false + location: body + modelType: *ref_2 + name: + fixed: false + raw: petParam + serializedName: petParam + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Pet_AddPet + url: /extensibleenums/pet/addPet + name: + fixed: false + raw: Pet + nameForProperty: Pet + typeName: + fixed: false +properties: + - *ref_3 diff --git a/test/Expected/head-exceptions/code-model-v1-yaml.yaml b/test/Expected/head-exceptions/code-model-v1-yaml.yaml new file mode 100644 index 0000000..139ea5b --- /dev/null +++ b/test/Expected/head-exceptions/code-model-v1-yaml.yaml @@ -0,0 +1,84 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +modelsName: Models +name: AutoRestHeadExceptionTestService +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Return 200 status code if successful + group: + fixed: false + raw: headException + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: headException_head200 + url: /http/success/200 + - defaultResponse: + isNullable: true + deprecated: false + description: Return 204 status code if successful + group: + fixed: false + raw: headException + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head204 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: headException_head204 + url: /http/success/204 + - defaultResponse: + isNullable: true + deprecated: false + description: Return 404 status code if successful + group: + fixed: false + raw: headException + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head404 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: headException_head404 + url: /http/success/404 + name: + fixed: false + raw: HeadException + nameForProperty: HeadException + typeName: + fixed: false diff --git a/test/Expected/head/code-model-v1-yaml.yaml b/test/Expected/head/code-model-v1-yaml.yaml new file mode 100644 index 0000000..bd23c90 --- /dev/null +++ b/test/Expected/head/code-model-v1-yaml.yaml @@ -0,0 +1,90 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +modelsName: Models +name: AutoRestHeadTestService +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Return 200 status code if successful + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_head200 + url: /http/success/200 + - defaultResponse: + isNullable: true + deprecated: false + description: Return 204 status code if successful + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head204 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_head204 + url: /http/success/204 + - defaultResponse: + isNullable: true + deprecated: false + description: Return 404 status code if successful + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head404 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_head404 + url: /http/success/404 + name: + fixed: false + raw: HttpSuccess + nameForProperty: HttpSuccess + typeName: + fixed: false diff --git a/test/Expected/header/code-model-v1-yaml.yaml b/test/Expected/header/code-model-v1-yaml.yaml new file mode 100644 index 0000000..487ee19 --- /dev/null +++ b/test/Expected/header/code-model-v1-yaml.yaml @@ -0,0 +1,2103 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +enumTypes: + - &ref_0 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: GreyscaleColors + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: White + serializedName: White + - name: black + serializedName: black + - name: GREY + serializedName: GREY +errorTypes: + - &ref_1 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +headerTypes: + - &ref_2 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseExistingKey operation. + name: + fixed: false + raw: header-responseExistingKey-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'response with header value "User-Agent": "overwrite"' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: User-Agent + realPath: + - User-Agent + serializedName: User-Agent + serializedName: header-responseExistingKey-Headers + - &ref_3 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseProtectedKey operation. + name: + fixed: false + raw: header-responseProtectedKey-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'response with header value "Content-Type": "text/html"' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Content-Type + realPath: + - Content-Type + serializedName: Content-Type + serializedName: header-responseProtectedKey-Headers + - &ref_4 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseInteger operation. + name: + fixed: false + raw: header-responseInteger-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'response with header value "value": 1 or -2' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseInteger-Headers + - &ref_5 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseLong operation. + name: + fixed: false + raw: header-responseLong-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'response with header value "value": 105 or -2' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseLong-Headers + - &ref_6 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseFloat operation. + name: + fixed: false + raw: header-responseFloat-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'response with header value "value": 0.07 or -3.0' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseFloat-Headers + - &ref_7 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseDouble operation. + name: + fixed: false + raw: header-responseDouble-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'response with header value "value": 7e120 or -3.0' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseDouble-Headers + - &ref_8 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseBool operation. + name: + fixed: false + raw: header-responseBool-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'response with header value "value": true or false' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseBool-Headers + - &ref_9 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseString operation. + name: + fixed: false + raw: header-responseString-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + response with header values "The quick brown fox jumps over the lazy + dog" or null or "" + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseString-Headers + - &ref_10 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseDate operation. + name: + fixed: false + raw: header-responseDate-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: response with header values "2010-01-01" or "0001-01-01" + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseDate-Headers + - &ref_11 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseDatetime operation. + name: + fixed: false + raw: header-responseDatetime-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + response with header values "2010-01-01T12:34:56Z" or + "0001-01-01T00:00:00Z" + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseDatetime-Headers + - &ref_12 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseDatetimeRfc1123 operation. + name: + fixed: false + raw: header-responseDatetimeRfc1123-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + response with header values "Wed, 01 Jan 2010 12:34:56 GMT" or "Mon, + 01 Jan 0001 00:00:00 GMT" + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseDatetimeRfc1123-Headers + - &ref_13 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseDuration operation. + name: + fixed: false + raw: header-responseDuration-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: response with header values "P123DT22H14M12.011S" + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseDuration-Headers + - &ref_14 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseByte operation. + name: + fixed: false + raw: header-responseByte-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: response with header values "啊齄丂狛狜隣郎隣兀﨩" + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseByte-Headers + - &ref_15 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for responseEnum operation. + name: + fixed: false + raw: header-responseEnum-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: response with header values "GREY" or null + extensions: + x-ms-enum: + modelAsString: false + name: GreyscaleColors + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: header-responseEnum-Headers +modelTypes: + - *ref_1 +modelsName: Models +name: AutoRestSwaggerBATHeaderService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: 'Send a post request with header value "User-Agent": "overwrite"' + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramExistingKey + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Send a post request with header value "User-Agent": "overwrite"' + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: User-Agent + serializedName: User-Agent + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramExistingKey + url: /header/param/existingkey + - defaultResponse: + body: *ref_1 + headers: *ref_2 + isNullable: true + deprecated: false + description: 'Get a response with header value "User-Agent": "overwrite"' + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseExistingKey + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_2 + isNullable: true + returnType: + headers: *ref_2 + isNullable: true + serializedName: header_responseExistingKey + url: /header/response/existingkey + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: 'Send a post request with header value "Content-Type": "text/html"' + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramProtectedKey + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header value "Content-Type": + "text/html" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Content-Type + serializedName: Content-Type + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramProtectedKey + url: /header/param/protectedkey + - defaultResponse: + body: *ref_1 + headers: *ref_3 + isNullable: true + deprecated: false + description: 'Get a response with header value "Content-Type": "text/html"' + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseProtectedKey + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_3 + isNullable: true + returnType: + headers: *ref_3 + isNullable: true + serializedName: header_responseProtectedKey + url: /header/response/protectedkey + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "positive", + "value": 1 or "scenario": "negative", "value": -2 + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramInteger + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "positive" or + "negative" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Send a post request with header values 1 or -2 + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramInteger + url: /header/param/prim/integer + - defaultResponse: + body: *ref_1 + headers: *ref_4 + isNullable: true + deprecated: false + description: 'Get a response with header value "value": 1 or -2' + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseInteger + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "positive" or + "negative" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_4 + isNullable: true + returnType: + headers: *ref_4 + isNullable: true + serializedName: header_responseInteger + url: /header/response/prim/integer + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "positive", + "value": 105 or "scenario": "negative", "value": -2 + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramLong + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "positive" or + "negative" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Send a post request with header values 105 or -2 + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramLong + url: /header/param/prim/long + - defaultResponse: + body: *ref_1 + headers: *ref_5 + isNullable: true + deprecated: false + description: 'Get a response with header value "value": 105 or -2' + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseLong + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "positive" or + "negative" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_5 + isNullable: true + returnType: + headers: *ref_5 + isNullable: true + serializedName: header_responseLong + url: /header/response/prim/long + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "positive", + "value": 0.07 or "scenario": "negative", "value": -3.0 + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramFloat + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "positive" or + "negative" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Send a post request with header values 0.07 or -3.0 + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramFloat + url: /header/param/prim/float + - defaultResponse: + body: *ref_1 + headers: *ref_6 + isNullable: true + deprecated: false + description: 'Get a response with header value "value": 0.07 or -3.0' + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseFloat + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "positive" or + "negative" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_6 + isNullable: true + returnType: + headers: *ref_6 + isNullable: true + serializedName: header_responseFloat + url: /header/response/prim/float + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "positive", + "value": 7e120 or "scenario": "negative", "value": -3.0 + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramDouble + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "positive" or + "negative" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Send a post request with header values 7e120 or -3.0 + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramDouble + url: /header/param/prim/double + - defaultResponse: + body: *ref_1 + headers: *ref_7 + isNullable: true + deprecated: false + description: 'Get a response with header value "value": 7e120 or -3.0' + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseDouble + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "positive" or + "negative" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_7 + isNullable: true + returnType: + headers: *ref_7 + isNullable: true + serializedName: header_responseDouble + url: /header/response/prim/double + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "true", "value": + true or "scenario": "false", "value": false + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramBool + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "true" or + "false" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Send a post request with header values true or false + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramBool + url: /header/param/prim/bool + - defaultResponse: + body: *ref_1 + headers: *ref_8 + isNullable: true + deprecated: false + description: 'Get a response with header value "value": true or false' + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseBool + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "true" or + "false" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_8 + isNullable: true + returnType: + headers: *ref_8 + isNullable: true + serializedName: header_responseBool + url: /header/response/prim/bool + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "valid", "value": + "The quick brown fox jumps over the lazy dog" or "scenario": "null", + "value": null or "scenario": "empty", "value": "" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramString + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "null" or "empty" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "The quick brown fox + jumps over the lazy dog" or null or "" + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramString + url: /header/param/prim/string + - defaultResponse: + body: *ref_1 + headers: *ref_9 + isNullable: true + deprecated: false + description: >- + Get a response with header values "The quick brown fox jumps over the + lazy dog" or null or "" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseString + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "null" or "empty" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_9 + isNullable: true + returnType: + headers: *ref_9 + isNullable: true + serializedName: header_responseString + url: /header/response/prim/string + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "valid", "value": + "2010-01-01" or "scenario": "min", "value": "0001-01-01" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramDate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "min" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "2010-01-01" or + "0001-01-01" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramDate + url: /header/param/prim/date + - defaultResponse: + body: *ref_1 + headers: *ref_10 + isNullable: true + deprecated: false + description: Get a response with header values "2010-01-01" or "0001-01-01" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseDate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "min" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_10 + isNullable: true + returnType: + headers: *ref_10 + isNullable: true + serializedName: header_responseDate + url: /header/response/prim/date + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "valid", "value": + "2010-01-01T12:34:56Z" or "scenario": "min", "value": + "0001-01-01T00:00:00Z" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramDatetime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "min" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "2010-01-01T12:34:56Z" or + "0001-01-01T00:00:00Z" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramDatetime + url: /header/param/prim/datetime + - defaultResponse: + body: *ref_1 + headers: *ref_11 + isNullable: true + deprecated: false + description: >- + Get a response with header values "2010-01-01T12:34:56Z" or + "0001-01-01T00:00:00Z" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseDatetime + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "min" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_11 + isNullable: true + returnType: + headers: *ref_11 + isNullable: true + serializedName: header_responseDatetime + url: /header/response/prim/datetime + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "valid", "value": + "Wed, 01 Jan 2010 12:34:56 GMT" or "scenario": "min", "value": "Mon, + 01 Jan 0001 00:00:00 GMT" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramDatetimeRfc1123 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "min" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "Wed, 01 Jan 2010 + 12:34:56 GMT" or "Mon, 01 Jan 0001 00:00:00 GMT" + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramDatetimeRfc1123 + url: /header/param/prim/datetimerfc1123 + - defaultResponse: + body: *ref_1 + headers: *ref_12 + isNullable: true + deprecated: false + description: >- + Get a response with header values "Wed, 01 Jan 2010 12:34:56 GMT" or + "Mon, 01 Jan 0001 00:00:00 GMT" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseDatetimeRfc1123 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "min" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_12 + isNullable: true + returnType: + headers: *ref_12 + isNullable: true + serializedName: header_responseDatetimeRfc1123 + url: /header/response/prim/datetimerfc1123 + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "valid", "value": + "P123DT22H14M12.011S" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramDuration + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Send a post request with header values "scenario": "valid"' + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Send a post request with header values "P123DT22H14M12.011S" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramDuration + url: /header/param/prim/duration + - defaultResponse: + body: *ref_1 + headers: *ref_13 + isNullable: true + deprecated: false + description: Get a response with header values "P123DT22H14M12.011S" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseDuration + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Send a post request with header values "scenario": "valid"' + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_13 + isNullable: true + returnType: + headers: *ref_13 + isNullable: true + serializedName: header_responseDuration + url: /header/response/prim/duration + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "valid", "value": + "啊齄丂狛狜隣郎隣兀﨩" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramByte + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Send a post request with header values "scenario": "valid"' + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Send a post request with header values "啊齄丂狛狜隣郎隣兀﨩" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramByte + url: /header/param/prim/byte + - defaultResponse: + body: *ref_1 + headers: *ref_14 + isNullable: true + deprecated: false + description: Get a response with header values "啊齄丂狛狜隣郎隣兀﨩" + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseByte + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Send a post request with header values "scenario": "valid"' + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_14 + isNullable: true + returnType: + headers: *ref_14 + isNullable: true + serializedName: header_responseByte + url: /header/response/prim/byte + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send a post request with header values "scenario": "valid", "value": + "GREY" or "scenario": "null", "value": null + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: paramEnum + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "null" or "empty" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Send a post request with header values ''GREY'' ' + extensions: + x-ms-enum: + modelAsString: false + name: GreyscaleColors + isConstant: false + isRequired: false + location: header + modelType: *ref_0 + name: + fixed: false + raw: value + serializedName: value + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_paramEnum + url: /header/param/prim/enum + - defaultResponse: + body: *ref_1 + headers: *ref_15 + isNullable: true + deprecated: false + description: Get a response with header values "GREY" or null + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: responseEnum + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Send a post request with header values "scenario": "valid" or + "null" or "empty" + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scenario + serializedName: scenario + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_15 + isNullable: true + returnType: + headers: *ref_15 + isNullable: true + serializedName: header_responseEnum + url: /header/response/prim/enum + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Send x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 in + the header of the request + group: + fixed: false + raw: header + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: customRequestId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: header_customRequestId + url: >- + /header/custom/x-ms-client-request-id/9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 + name: + fixed: false + raw: Header + nameForProperty: Header + typeName: + fixed: false diff --git a/test/Expected/httpInfrastructure.quirks/code-model-v1-yaml.yaml b/test/Expected/httpInfrastructure.quirks/code-model-v1-yaml.yaml new file mode 100644 index 0000000..7431352 --- /dev/null +++ b/test/Expected/httpInfrastructure.quirks/code-model-v1-yaml.yaml @@ -0,0 +1,4581 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error + - &ref_1 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-client-name: + name: MyException + name: + fixed: false + raw: A + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: statusCode + realPath: + - statusCode + serializedName: statusCode + serializedName: A +headerTypes: + - &ref_6 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for head300 operation. + name: + fixed: false + raw: httpRedirects-head300-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/head/200 + serializedName: /http/success/head/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-head300-Headers + - &ref_7 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for get300 operation. + name: + fixed: false + raw: httpRedirects-get300-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-get300-Headers + - &ref_9 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for head301 operation. + name: + fixed: false + raw: httpRedirects-head301-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/head/200 + serializedName: /http/success/head/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-head301-Headers + - &ref_10 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for get301 operation. + name: + fixed: false + raw: httpRedirects-get301-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-get301-Headers + - &ref_11 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for put301 operation. + name: + fixed: false + raw: httpRedirects-put301-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/failure/500 + serializedName: /http/failure/500 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-put301-Headers + - &ref_12 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for head302 operation. + name: + fixed: false + raw: httpRedirects-head302-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/head/200 + serializedName: /http/success/head/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-head302-Headers + - &ref_13 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for get302 operation. + name: + fixed: false + raw: httpRedirects-get302-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-get302-Headers + - &ref_14 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for patch302 operation. + name: + fixed: false + raw: httpRedirects-patch302-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/failure/500 + serializedName: /http/failure/500 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-patch302-Headers + - &ref_15 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post303 operation. + name: + fixed: false + raw: httpRedirects-post303-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-post303-Headers + - &ref_16 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for head307 operation. + name: + fixed: false + raw: httpRedirects-head307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/head/200 + serializedName: /http/success/head/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-head307-Headers + - &ref_17 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for get307 operation. + name: + fixed: false + raw: httpRedirects-get307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-get307-Headers + - &ref_18 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for put307 operation. + name: + fixed: false + raw: HttpRedirects-put307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/put/200 + serializedName: /http/success/put/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: HttpRedirects-put307-Headers + - &ref_19 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for patch307 operation. + name: + fixed: false + raw: httpRedirects-patch307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/patch/200 + serializedName: /http/success/patch/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-patch307-Headers + - &ref_20 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post307 operation. + name: + fixed: false + raw: httpRedirects-post307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/post/200 + serializedName: /http/success/post/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-post307-Headers + - &ref_21 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for delete307 operation. + name: + fixed: false + raw: httpRedirects-delete307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/delete/200 + serializedName: /http/success/delete/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-delete307-Headers +modelTypes: + - *ref_0 + - *ref_1 + - &ref_22 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + name: + fixed: false + raw: B + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: textStatusCode + realPath: + - textStatusCode + serializedName: textStatusCode + serializedName: B + - &ref_23 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: C + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: httpCode + realPath: + - httpCode + serializedName: httpCode + serializedName: C + - &ref_24 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: D + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: httpStatusCode + realPath: + - httpStatusCode + serializedName: httpStatusCode + serializedName: D +modelsName: Models +name: AutoRestHttpInfrastructureTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get empty error form server + group: + fixed: false + raw: httpFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmptyError + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: httpFailure_getEmptyError + url: /http/failure/emptybody/error + - defaultResponse: + isNullable: true + deprecated: false + description: Get empty error form server + group: + fixed: false + raw: httpFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNoModelError + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: httpFailure_getNoModelError + url: /http/failure/nomodel/error + - defaultResponse: + isNullable: true + deprecated: false + description: Get empty response from server + group: + fixed: false + raw: httpFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNoModelEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: httpFailure_getNoModelEmpty + url: /http/failure/nomodel/empty + name: + fixed: false + raw: HttpFailure + nameForProperty: HttpFailure + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Return 200 status code if successful + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_head200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get 200 success + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: httpSuccess_get200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put boolean value true returning 200 success + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_put200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Patch true Boolean value in request returning 200 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_patch200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post bollean value true in request that returns a 200 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_post200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Delete simple boolean value true returns 200 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_delete200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put true Boolean value in request returns 201 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put201 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_put201 + url: /http/success/201 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post true Boolean value in request returns 201 (Created) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post201 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_post201 + url: /http/success/201 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put true Boolean value in request returns 202 (Accepted) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put202 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_put202 + url: /http/success/202 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Patch true Boolean value in request returns 202 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch202 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_patch202 + url: /http/success/202 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post true Boolean value in request returns 202 (Accepted) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post202 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_post202 + url: /http/success/202 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Delete true Boolean value in request returns 202 (accepted) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete202 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_delete202 + url: /http/success/202 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Return 204 status code if successful + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head204 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_head204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put true Boolean value in request returns 204 (no content) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_put204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Patch true Boolean value in request returns 204 (no content) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_patch204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post true Boolean value in request returns 204 (no content) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: HttpSuccess + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: HttpSuccess_post204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Delete true Boolean value in request returns 204 (no content) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_delete204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Return 404 status code + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head404 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_head404 + url: /http/success/404 + name: + fixed: false + raw: HttpSuccess + nameForProperty: HttpSuccess + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + headers: *ref_6 + isNullable: true + deprecated: false + description: Return 300 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head300 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MultipleChoices: + headers: *ref_6 + isNullable: true + OK: + headers: *ref_6 + isNullable: true + returnType: + headers: *ref_6 + isNullable: true + serializedName: httpRedirects_head300 + url: /http/redirect/300 + - defaultResponse: + body: *ref_0 + headers: *ref_7 + isNullable: true + deprecated: false + description: Return 300 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get300 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MultipleChoices: + body: &ref_8 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + headers: *ref_7 + isNullable: true + OK: + headers: *ref_7 + isNullable: true + returnType: + body: *ref_8 + headers: *ref_7 + isNullable: true + serializedName: httpRedirects_get300 + url: /http/redirect/300 + - defaultResponse: + body: *ref_0 + headers: *ref_9 + isNullable: true + deprecated: false + description: Return 301 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head301 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MovedPermanently: + headers: *ref_9 + isNullable: true + OK: + headers: *ref_9 + isNullable: true + returnType: + headers: *ref_9 + isNullable: true + serializedName: httpRedirects_head301 + url: /http/redirect/301 + - defaultResponse: + body: *ref_0 + headers: *ref_10 + isNullable: true + deprecated: false + description: Return 301 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get301 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MovedPermanently: + headers: *ref_10 + isNullable: true + OK: + headers: *ref_10 + isNullable: true + returnType: + headers: *ref_10 + isNullable: true + serializedName: httpRedirects_get301 + url: /http/redirect/301 + - defaultResponse: + body: *ref_0 + headers: *ref_11 + isNullable: true + deprecated: false + description: >- + Put true Boolean value in request returns 301. This request should + not be automatically redirected, but should return the received 301 to + the caller for evaluation + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put301 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MovedPermanently: + headers: *ref_11 + isNullable: true + returnType: + headers: *ref_11 + isNullable: true + serializedName: httpRedirects_put301 + url: /http/redirect/301 + - defaultResponse: + body: *ref_0 + headers: *ref_12 + isNullable: true + deprecated: false + description: Return 302 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head302 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_12 + isNullable: true + Redirect: + headers: *ref_12 + isNullable: true + returnType: + headers: *ref_12 + isNullable: true + serializedName: httpRedirects_head302 + url: /http/redirect/302 + - defaultResponse: + body: *ref_0 + headers: *ref_13 + isNullable: true + deprecated: false + description: Return 302 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get302 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_13 + isNullable: true + Redirect: + headers: *ref_13 + isNullable: true + returnType: + headers: *ref_13 + isNullable: true + serializedName: httpRedirects_get302 + url: /http/redirect/302 + - defaultResponse: + body: *ref_0 + headers: *ref_14 + isNullable: true + deprecated: false + description: >- + Patch true Boolean value in request returns 302. This request should + not be automatically redirected, but should return the received 302 to + the caller for evaluation + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch302 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Redirect: + headers: *ref_14 + isNullable: true + returnType: + headers: *ref_14 + isNullable: true + serializedName: httpRedirects_patch302 + url: /http/redirect/302 + - defaultResponse: + body: *ref_0 + headers: *ref_15 + isNullable: true + deprecated: false + description: >- + Post true Boolean value in request returns 303. This request should + be automatically redirected usign a get, ultimately returning a 200 + status code + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post303 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_15 + isNullable: true + SeeOther: + headers: *ref_15 + isNullable: true + returnType: + headers: *ref_15 + isNullable: true + serializedName: httpRedirects_post303 + url: /http/redirect/303 + - defaultResponse: + body: *ref_0 + headers: *ref_16 + isNullable: true + deprecated: false + description: 'Redirect with 307, resulting in a 200 success' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head307 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_16 + isNullable: true + TemporaryRedirect: + headers: *ref_16 + isNullable: true + returnType: + headers: *ref_16 + isNullable: true + serializedName: httpRedirects_head307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_17 + isNullable: true + deprecated: false + description: 'Redirect get with 307, resulting in a 200 success' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get307 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_17 + isNullable: true + TemporaryRedirect: + headers: *ref_17 + isNullable: true + returnType: + headers: *ref_17 + isNullable: true + serializedName: httpRedirects_get307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_18 + isNullable: true + deprecated: false + description: 'Put redirected with 307, resulting in a 200 after redirect' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: HttpRedirects + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put307 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_18 + isNullable: true + TemporaryRedirect: + headers: *ref_18 + isNullable: true + returnType: + headers: *ref_18 + isNullable: true + serializedName: HttpRedirects_put307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_19 + isNullable: true + deprecated: false + description: 'Patch redirected with 307, resulting in a 200 after redirect' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch307 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_19 + isNullable: true + TemporaryRedirect: + headers: *ref_19 + isNullable: true + returnType: + headers: *ref_19 + isNullable: true + serializedName: httpRedirects_patch307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_20 + isNullable: true + deprecated: false + description: 'Post redirected with 307, resulting in a 200 after redirect' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post307 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_20 + isNullable: true + TemporaryRedirect: + headers: *ref_20 + isNullable: true + returnType: + headers: *ref_20 + isNullable: true + serializedName: httpRedirects_post307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_21 + isNullable: true + deprecated: false + description: 'Delete redirected with 307, resulting in a 200 after redirect' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete307 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_21 + isNullable: true + TemporaryRedirect: + headers: *ref_21 + isNullable: true + returnType: + headers: *ref_21 + isNullable: true + serializedName: httpRedirects_delete307 + url: /http/redirect/307 + name: + fixed: false + raw: HttpRedirects + nameForProperty: HttpRedirects + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head400 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_head400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get400 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_put400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_patch400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_post400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_delete400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 401 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head401 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_head401 + url: /http/failure/client/401 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 402 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get402 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get402 + url: /http/failure/client/402 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 403 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get403 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get403 + url: /http/failure/client/403 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 404 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put404 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_put404 + url: /http/failure/client/404 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 405 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch405 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_patch405 + url: /http/failure/client/405 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 406 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post406 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_post406 + url: /http/failure/client/406 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 407 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete407 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_delete407 + url: /http/failure/client/407 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 409 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put409 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_put409 + url: /http/failure/client/409 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 410 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head410 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_head410 + url: /http/failure/client/410 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 411 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get411 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get411 + url: /http/failure/client/411 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 412 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get412 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get412 + url: /http/failure/client/412 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 413 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put413 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_put413 + url: /http/failure/client/413 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 414 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch414 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_patch414 + url: /http/failure/client/414 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 415 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post415 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_post415 + url: /http/failure/client/415 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 416 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get416 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get416 + url: /http/failure/client/416 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 417 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete417 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_delete417 + url: /http/failure/client/417 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 429 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head429 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_head429 + url: /http/failure/client/429 + name: + fixed: false + raw: HttpClientFailure + nameForProperty: HttpClientFailure + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 501 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpServerFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head501 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpServerFailure_head501 + url: /http/failure/server/501 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 501 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpServerFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get501 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpServerFailure_get501 + url: /http/failure/server/501 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 505 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpServerFailure + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post505 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpServerFailure_post505 + url: /http/failure/server/505 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 505 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpServerFailure + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete505 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpServerFailure_delete505 + url: /http/failure/server/505 + name: + fixed: false + raw: HttpServerFailure + nameForProperty: HttpServerFailure + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 408 status code, then 200 after retry' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head408 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_head408 + url: /http/retry/408 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 500 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put500 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_put500 + url: /http/retry/500 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 500 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch500 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_patch500 + url: /http/retry/500 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 502 status code, then 200 after retry' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get502 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_get502 + url: /http/retry/502 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 503 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post503 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_post503 + url: /http/retry/503 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 503 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete503 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_delete503 + url: /http/retry/503 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 504 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put504 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_put504 + url: /http/retry/504 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 504 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch504 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_patch504 + url: /http/retry/504 + name: + fixed: false + raw: HttpRetry + nameForProperty: HttpRetry + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError200Valid + url: /http/payloads/200/A/204/none/default/Error/response/200/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Send a 204 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError204Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError204Valid + url: /http/payloads/200/A/204/none/default/Error/response/204/none + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 201 response with valid payload: {''statusCode'': ''201''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError201Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError201Invalid + url: /http/payloads/200/A/204/none/default/Error/response/201/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 202 response with no payload:' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError202None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError202None + url: /http/payloads/200/A/204/none/default/Error/response/202/none + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 400 response with valid error payload: {'status': 400, + 'message': 'client error'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError400Valid + url: /http/payloads/200/A/204/none/default/Error/response/400/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model201ModelDefaultError200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_22 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model201ModelDefaultError200Valid + url: /http/payloads/200/A/201/B/default/Error/response/200/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 201 response with valid payload: {'statusCode': '201', + 'textStatusCode': 'Created'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model201ModelDefaultError201Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_22 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model201ModelDefaultError201Valid + url: /http/payloads/200/A/201/B/default/Error/response/201/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 400 response with valid payload: {'code': '400', 'message': + 'client error'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model201ModelDefaultError400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_22 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model201ModelDefaultError400Valid + url: /http/payloads/200/A/201/B/default/Error/response/400/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA201ModelC404ModelDDefaultError200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_23 + isNullable: true + NotFound: + body: *ref_24 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + isNullable: true + serializedName: multipleResponses_get200ModelA201ModelC404ModelDDefaultError200Valid + url: /http/payloads/200/A/201/C/404/D/default/Error/response/200/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''httpCode'': ''201''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA201ModelC404ModelDDefaultError201Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_23 + isNullable: true + NotFound: + body: *ref_24 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + isNullable: true + serializedName: multipleResponses_get200ModelA201ModelC404ModelDDefaultError201Valid + url: /http/payloads/200/A/201/C/404/D/default/Error/response/201/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''httpStatusCode'': ''404''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA201ModelC404ModelDDefaultError404Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_23 + isNullable: true + NotFound: + body: *ref_24 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + isNullable: true + serializedName: multipleResponses_get200ModelA201ModelC404ModelDDefaultError404Valid + url: /http/payloads/200/A/201/C/404/D/default/Error/response/404/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 400 response with valid payload: {'code': '400', 'message': + 'client error'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA201ModelC404ModelDDefaultError400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_23 + isNullable: true + NotFound: + body: *ref_24 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + isNullable: true + serializedName: multipleResponses_get200ModelA201ModelC404ModelDDefaultError400Valid + url: /http/payloads/200/A/201/C/404/D/default/Error/response/400/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Send a 202 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultError202None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultError202None + url: /http/payloads/202/none/204/none/default/Error/response/202/none + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Send a 204 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultError204None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultError204None + url: /http/payloads/202/none/204/none/default/Error/response/204/none + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 400 response with valid payload: {'code': '400', 'message': + 'client error'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultError400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultError400Valid + url: /http/payloads/202/none/204/none/default/Error/response/400/valid + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 202 response with an unexpected payload {''property'': ''value''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultNone202Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultNone202Invalid + url: /http/payloads/202/none/204/none/default/none/response/202/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: Send a 204 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultNone204None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultNone204None + url: /http/payloads/202/none/204/none/default/none/response/204/none + - defaultResponse: + isNullable: true + deprecated: false + description: Send a 400 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultNone400None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultNone400None + url: /http/payloads/202/none/204/none/default/none/response/400/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 400 response with an unexpected payload {''property'': ''value''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultNone400Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultNone400Invalid + url: /http/payloads/202/none/204/none/default/none/response/400/invalid + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultModelA200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_getDefaultModelA200Valid + url: /http/payloads/default/A/response/200/valid + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Send a 200 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultModelA200None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_getDefaultModelA200None + url: /http/payloads/default/A/response/200/none + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: 'Send a 400 response with valid payload: {''statusCode'': ''400''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultModelA400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_getDefaultModelA400Valid + url: /http/payloads/default/A/response/400/valid + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Send a 400 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultModelA400None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_getDefaultModelA400None + url: /http/payloads/default/A/response/400/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with invalid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultNone200Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + isNullable: true + serializedName: multipleResponses_getDefaultNone200Invalid + url: /http/payloads/default/none/response/200/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: Send a 200 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultNone200None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + isNullable: true + serializedName: multipleResponses_getDefaultNone200None + url: /http/payloads/default/none/response/200/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 400 response with valid payload: {''statusCode'': ''400''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultNone400Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + isNullable: true + serializedName: multipleResponses_getDefaultNone400Invalid + url: /http/payloads/default/none/response/400/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: Send a 400 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultNone400None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + isNullable: true + serializedName: multipleResponses_getDefaultNone400None + url: /http/payloads/default/none/response/400/none + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Send a 200 response with no payload, when a payload is expected - + client should return a null object of thde type for model A + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA200None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA200None + url: /http/payloads/200/A/response/200/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with payload {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA200Valid + url: /http/payloads/200/A/response/200/valid + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with invalid payload {''statusCodeInvalid'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA200Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA200Invalid + url: /http/payloads/200/A/response/200/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Send a 400 response with no payload client should treat as an http + error with no error model + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA400None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA400None + url: /http/payloads/200/A/response/400/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with payload {''statusCode'': ''400''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA400Valid + url: /http/payloads/200/A/response/400/valid + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with invalid payload {''statusCodeInvalid'': ''400''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA400Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA400Invalid + url: /http/payloads/200/A/response/400/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 202 response with payload {''statusCode'': ''202''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA202Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA202Valid + url: /http/payloads/200/A/response/202/valid + name: + fixed: false + raw: MultipleResponses + nameForProperty: MultipleResponses + typeName: + fixed: false diff --git a/test/Expected/httpInfrastructure/code-model-v1-yaml.yaml b/test/Expected/httpInfrastructure/code-model-v1-yaml.yaml new file mode 100644 index 0000000..7431352 --- /dev/null +++ b/test/Expected/httpInfrastructure/code-model-v1-yaml.yaml @@ -0,0 +1,4581 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error + - &ref_1 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-client-name: + name: MyException + name: + fixed: false + raw: A + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: statusCode + realPath: + - statusCode + serializedName: statusCode + serializedName: A +headerTypes: + - &ref_6 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for head300 operation. + name: + fixed: false + raw: httpRedirects-head300-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/head/200 + serializedName: /http/success/head/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-head300-Headers + - &ref_7 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for get300 operation. + name: + fixed: false + raw: httpRedirects-get300-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-get300-Headers + - &ref_9 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for head301 operation. + name: + fixed: false + raw: httpRedirects-head301-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/head/200 + serializedName: /http/success/head/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-head301-Headers + - &ref_10 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for get301 operation. + name: + fixed: false + raw: httpRedirects-get301-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-get301-Headers + - &ref_11 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for put301 operation. + name: + fixed: false + raw: httpRedirects-put301-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/failure/500 + serializedName: /http/failure/500 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-put301-Headers + - &ref_12 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for head302 operation. + name: + fixed: false + raw: httpRedirects-head302-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/head/200 + serializedName: /http/success/head/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-head302-Headers + - &ref_13 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for get302 operation. + name: + fixed: false + raw: httpRedirects-get302-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-get302-Headers + - &ref_14 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for patch302 operation. + name: + fixed: false + raw: httpRedirects-patch302-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/failure/500 + serializedName: /http/failure/500 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-patch302-Headers + - &ref_15 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post303 operation. + name: + fixed: false + raw: httpRedirects-post303-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-post303-Headers + - &ref_16 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for head307 operation. + name: + fixed: false + raw: httpRedirects-head307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/head/200 + serializedName: /http/success/head/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-head307-Headers + - &ref_17 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for get307 operation. + name: + fixed: false + raw: httpRedirects-get307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/get/200 + serializedName: /http/success/get/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-get307-Headers + - &ref_18 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for put307 operation. + name: + fixed: false + raw: HttpRedirects-put307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/put/200 + serializedName: /http/success/put/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: HttpRedirects-put307-Headers + - &ref_19 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for patch307 operation. + name: + fixed: false + raw: httpRedirects-patch307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/patch/200 + serializedName: /http/success/patch/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-patch307-Headers + - &ref_20 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post307 operation. + name: + fixed: false + raw: httpRedirects-post307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/post/200 + serializedName: /http/success/post/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-post307-Headers + - &ref_21 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for delete307 operation. + name: + fixed: false + raw: httpRedirects-delete307-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The redirect location for this request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: /http/success/delete/200 + serializedName: /http/success/delete/200 + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: httpRedirects-delete307-Headers +modelTypes: + - *ref_0 + - *ref_1 + - &ref_22 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + name: + fixed: false + raw: B + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: textStatusCode + realPath: + - textStatusCode + serializedName: textStatusCode + serializedName: B + - &ref_23 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: C + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: httpCode + realPath: + - httpCode + serializedName: httpCode + serializedName: C + - &ref_24 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: D + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: httpStatusCode + realPath: + - httpStatusCode + serializedName: httpStatusCode + serializedName: D +modelsName: Models +name: AutoRestHttpInfrastructureTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get empty error form server + group: + fixed: false + raw: httpFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getEmptyError + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_2 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: httpFailure_getEmptyError + url: /http/failure/emptybody/error + - defaultResponse: + isNullable: true + deprecated: false + description: Get empty error form server + group: + fixed: false + raw: httpFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNoModelError + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: httpFailure_getNoModelError + url: /http/failure/nomodel/error + - defaultResponse: + isNullable: true + deprecated: false + description: Get empty response from server + group: + fixed: false + raw: httpFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNoModelEmpty + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_4 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: httpFailure_getNoModelEmpty + url: /http/failure/nomodel/empty + name: + fixed: false + raw: HttpFailure + nameForProperty: HttpFailure + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Return 200 status code if successful + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_head200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get 200 success + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_5 + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: httpSuccess_get200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put boolean value true returning 200 success + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_put200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Patch true Boolean value in request returning 200 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_patch200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post bollean value true in request that returns a 200 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_post200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Delete simple boolean value true returns 200 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_delete200 + url: /http/success/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put true Boolean value in request returns 201 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put201 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_put201 + url: /http/success/201 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post true Boolean value in request returns 201 (Created) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post201 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_post201 + url: /http/success/201 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put true Boolean value in request returns 202 (Accepted) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put202 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_put202 + url: /http/success/202 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Patch true Boolean value in request returns 202 + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch202 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_patch202 + url: /http/success/202 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post true Boolean value in request returns 202 (Accepted) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post202 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_post202 + url: /http/success/202 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Delete true Boolean value in request returns 202 (accepted) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete202 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_delete202 + url: /http/success/202 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Return 204 status code if successful + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head204 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_head204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put true Boolean value in request returns 204 (no content) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_put204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Patch true Boolean value in request returns 204 (no content) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_patch204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Post true Boolean value in request returns 204 (no content) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: HttpSuccess + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: HttpSuccess_post204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Delete true Boolean value in request returns 204 (no content) + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_delete204 + url: /http/success/204 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Return 404 status code + group: + fixed: false + raw: httpSuccess + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head404 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: httpSuccess_head404 + url: /http/success/404 + name: + fixed: false + raw: HttpSuccess + nameForProperty: HttpSuccess + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + headers: *ref_6 + isNullable: true + deprecated: false + description: Return 300 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head300 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MultipleChoices: + headers: *ref_6 + isNullable: true + OK: + headers: *ref_6 + isNullable: true + returnType: + headers: *ref_6 + isNullable: true + serializedName: httpRedirects_head300 + url: /http/redirect/300 + - defaultResponse: + body: *ref_0 + headers: *ref_7 + isNullable: true + deprecated: false + description: Return 300 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get300 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MultipleChoices: + body: &ref_8 + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + headers: *ref_7 + isNullable: true + OK: + headers: *ref_7 + isNullable: true + returnType: + body: *ref_8 + headers: *ref_7 + isNullable: true + serializedName: httpRedirects_get300 + url: /http/redirect/300 + - defaultResponse: + body: *ref_0 + headers: *ref_9 + isNullable: true + deprecated: false + description: Return 301 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head301 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MovedPermanently: + headers: *ref_9 + isNullable: true + OK: + headers: *ref_9 + isNullable: true + returnType: + headers: *ref_9 + isNullable: true + serializedName: httpRedirects_head301 + url: /http/redirect/301 + - defaultResponse: + body: *ref_0 + headers: *ref_10 + isNullable: true + deprecated: false + description: Return 301 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get301 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MovedPermanently: + headers: *ref_10 + isNullable: true + OK: + headers: *ref_10 + isNullable: true + returnType: + headers: *ref_10 + isNullable: true + serializedName: httpRedirects_get301 + url: /http/redirect/301 + - defaultResponse: + body: *ref_0 + headers: *ref_11 + isNullable: true + deprecated: false + description: >- + Put true Boolean value in request returns 301. This request should + not be automatically redirected, but should return the received 301 to + the caller for evaluation + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put301 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + MovedPermanently: + headers: *ref_11 + isNullable: true + returnType: + headers: *ref_11 + isNullable: true + serializedName: httpRedirects_put301 + url: /http/redirect/301 + - defaultResponse: + body: *ref_0 + headers: *ref_12 + isNullable: true + deprecated: false + description: Return 302 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head302 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_12 + isNullable: true + Redirect: + headers: *ref_12 + isNullable: true + returnType: + headers: *ref_12 + isNullable: true + serializedName: httpRedirects_head302 + url: /http/redirect/302 + - defaultResponse: + body: *ref_0 + headers: *ref_13 + isNullable: true + deprecated: false + description: Return 302 status code and redirect to /http/success/200 + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get302 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_13 + isNullable: true + Redirect: + headers: *ref_13 + isNullable: true + returnType: + headers: *ref_13 + isNullable: true + serializedName: httpRedirects_get302 + url: /http/redirect/302 + - defaultResponse: + body: *ref_0 + headers: *ref_14 + isNullable: true + deprecated: false + description: >- + Patch true Boolean value in request returns 302. This request should + not be automatically redirected, but should return the received 302 to + the caller for evaluation + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch302 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Redirect: + headers: *ref_14 + isNullable: true + returnType: + headers: *ref_14 + isNullable: true + serializedName: httpRedirects_patch302 + url: /http/redirect/302 + - defaultResponse: + body: *ref_0 + headers: *ref_15 + isNullable: true + deprecated: false + description: >- + Post true Boolean value in request returns 303. This request should + be automatically redirected usign a get, ultimately returning a 200 + status code + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post303 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_15 + isNullable: true + SeeOther: + headers: *ref_15 + isNullable: true + returnType: + headers: *ref_15 + isNullable: true + serializedName: httpRedirects_post303 + url: /http/redirect/303 + - defaultResponse: + body: *ref_0 + headers: *ref_16 + isNullable: true + deprecated: false + description: 'Redirect with 307, resulting in a 200 success' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head307 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_16 + isNullable: true + TemporaryRedirect: + headers: *ref_16 + isNullable: true + returnType: + headers: *ref_16 + isNullable: true + serializedName: httpRedirects_head307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_17 + isNullable: true + deprecated: false + description: 'Redirect get with 307, resulting in a 200 success' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get307 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_17 + isNullable: true + TemporaryRedirect: + headers: *ref_17 + isNullable: true + returnType: + headers: *ref_17 + isNullable: true + serializedName: httpRedirects_get307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_18 + isNullable: true + deprecated: false + description: 'Put redirected with 307, resulting in a 200 after redirect' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: HttpRedirects + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put307 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_18 + isNullable: true + TemporaryRedirect: + headers: *ref_18 + isNullable: true + returnType: + headers: *ref_18 + isNullable: true + serializedName: HttpRedirects_put307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_19 + isNullable: true + deprecated: false + description: 'Patch redirected with 307, resulting in a 200 after redirect' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch307 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_19 + isNullable: true + TemporaryRedirect: + headers: *ref_19 + isNullable: true + returnType: + headers: *ref_19 + isNullable: true + serializedName: httpRedirects_patch307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_20 + isNullable: true + deprecated: false + description: 'Post redirected with 307, resulting in a 200 after redirect' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post307 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_20 + isNullable: true + TemporaryRedirect: + headers: *ref_20 + isNullable: true + returnType: + headers: *ref_20 + isNullable: true + serializedName: httpRedirects_post307 + url: /http/redirect/307 + - defaultResponse: + body: *ref_0 + headers: *ref_21 + isNullable: true + deprecated: false + description: 'Delete redirected with 307, resulting in a 200 after redirect' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRedirects + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete307 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_21 + isNullable: true + TemporaryRedirect: + headers: *ref_21 + isNullable: true + returnType: + headers: *ref_21 + isNullable: true + serializedName: httpRedirects_delete307 + url: /http/redirect/307 + name: + fixed: false + raw: HttpRedirects + nameForProperty: HttpRedirects + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head400 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_head400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get400 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_put400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_patch400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_post400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 400 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_delete400 + url: /http/failure/client/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 401 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head401 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_head401 + url: /http/failure/client/401 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 402 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get402 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get402 + url: /http/failure/client/402 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 403 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get403 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get403 + url: /http/failure/client/403 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 404 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put404 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_put404 + url: /http/failure/client/404 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 405 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch405 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_patch405 + url: /http/failure/client/405 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 406 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post406 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_post406 + url: /http/failure/client/406 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 407 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete407 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_delete407 + url: /http/failure/client/407 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 409 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put409 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_put409 + url: /http/failure/client/409 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 410 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head410 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_head410 + url: /http/failure/client/410 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 411 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get411 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get411 + url: /http/failure/client/411 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 412 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get412 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get412 + url: /http/failure/client/412 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 413 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put413 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_put413 + url: /http/failure/client/413 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 414 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch414 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_patch414 + url: /http/failure/client/414 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 415 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post415 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_post415 + url: /http/failure/client/415 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 416 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get416 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_get416 + url: /http/failure/client/416 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 417 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete417 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_delete417 + url: /http/failure/client/417 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 429 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpClientFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head429 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpClientFailure_head429 + url: /http/failure/client/429 + name: + fixed: false + raw: HttpClientFailure + nameForProperty: HttpClientFailure + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 501 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpServerFailure + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head501 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpServerFailure_head501 + url: /http/failure/server/501 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 501 status code - should be represented in the client as an + error + group: + fixed: false + raw: httpServerFailure + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get501 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpServerFailure_get501 + url: /http/failure/server/501 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 505 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpServerFailure + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post505 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpServerFailure_post505 + url: /http/failure/server/505 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Return 505 status code - should be represented in the client as an + error + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpServerFailure + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete505 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: httpServerFailure_delete505 + url: /http/failure/server/505 + name: + fixed: false + raw: HttpServerFailure + nameForProperty: HttpServerFailure + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 408 status code, then 200 after retry' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: head408 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_head408 + url: /http/retry/408 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 500 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put500 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_put500 + url: /http/retry/500 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 500 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch500 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_patch500 + url: /http/retry/500 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 502 status code, then 200 after retry' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get502 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_get502 + url: /http/retry/502 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 503 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post503 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_post503 + url: /http/retry/503 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 503 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete503 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_delete503 + url: /http/retry/503 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 504 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put504 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_put504 + url: /http/retry/504 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Return 504 status code, then 200 after retry' + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: httpRetry + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: patch504 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple boolean value true + extensions: + x-ms-requestBody-name: booleanValue + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: booleanValue + serializedName: booleanValue + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: httpRetry_patch504 + url: /http/retry/504 + name: + fixed: false + raw: HttpRetry + nameForProperty: HttpRetry + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError200Valid + url: /http/payloads/200/A/204/none/default/Error/response/200/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Send a 204 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError204Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError204Valid + url: /http/payloads/200/A/204/none/default/Error/response/204/none + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 201 response with valid payload: {''statusCode'': ''201''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError201Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError201Invalid + url: /http/payloads/200/A/204/none/default/Error/response/201/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 202 response with no payload:' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError202None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError202None + url: /http/payloads/200/A/204/none/default/Error/response/202/none + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 400 response with valid error payload: {'status': 400, + 'message': 'client error'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model204NoModelDefaultError400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model204NoModelDefaultError400Valid + url: /http/payloads/200/A/204/none/default/Error/response/400/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model201ModelDefaultError200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_22 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model201ModelDefaultError200Valid + url: /http/payloads/200/A/201/B/default/Error/response/200/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 201 response with valid payload: {'statusCode': '201', + 'textStatusCode': 'Created'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model201ModelDefaultError201Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_22 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model201ModelDefaultError201Valid + url: /http/payloads/200/A/201/B/default/Error/response/201/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 400 response with valid payload: {'code': '400', 'message': + 'client error'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200Model201ModelDefaultError400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_22 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200Model201ModelDefaultError400Valid + url: /http/payloads/200/A/201/B/default/Error/response/400/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA201ModelC404ModelDDefaultError200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_23 + isNullable: true + NotFound: + body: *ref_24 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + isNullable: true + serializedName: multipleResponses_get200ModelA201ModelC404ModelDDefaultError200Valid + url: /http/payloads/200/A/201/C/404/D/default/Error/response/200/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''httpCode'': ''201''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA201ModelC404ModelDDefaultError201Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_23 + isNullable: true + NotFound: + body: *ref_24 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + isNullable: true + serializedName: multipleResponses_get200ModelA201ModelC404ModelDDefaultError201Valid + url: /http/payloads/200/A/201/C/404/D/default/Error/response/201/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''httpStatusCode'': ''404''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA201ModelC404ModelDDefaultError404Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_23 + isNullable: true + NotFound: + body: *ref_24 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + isNullable: true + serializedName: multipleResponses_get200ModelA201ModelC404ModelDDefaultError404Valid + url: /http/payloads/200/A/201/C/404/D/default/Error/response/404/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 400 response with valid payload: {'code': '400', 'message': + 'client error'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA201ModelC404ModelDDefaultError400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_23 + isNullable: true + NotFound: + body: *ref_24 + isNullable: true + OK: + body: *ref_1 + isNullable: true + returnType: + body: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + isNullable: true + serializedName: multipleResponses_get200ModelA201ModelC404ModelDDefaultError400Valid + url: /http/payloads/200/A/201/C/404/D/default/Error/response/400/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Send a 202 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultError202None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultError202None + url: /http/payloads/202/none/204/none/default/Error/response/202/none + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Send a 204 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultError204None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultError204None + url: /http/payloads/202/none/204/none/default/Error/response/204/none + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Send a 400 response with valid payload: {'code': '400', 'message': + 'client error'} + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultError400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultError400Valid + url: /http/payloads/202/none/204/none/default/Error/response/400/valid + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 202 response with an unexpected payload {''property'': ''value''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultNone202Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultNone202Invalid + url: /http/payloads/202/none/204/none/default/none/response/202/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: Send a 204 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultNone204None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultNone204None + url: /http/payloads/202/none/204/none/default/none/response/204/none + - defaultResponse: + isNullable: true + deprecated: false + description: Send a 400 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultNone400None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultNone400None + url: /http/payloads/202/none/204/none/default/none/response/400/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 400 response with an unexpected payload {''property'': ''value''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get202None204NoneDefaultNone400Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: multipleResponses_get202None204NoneDefaultNone400Invalid + url: /http/payloads/202/none/204/none/default/none/response/400/invalid + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: 'Send a 200 response with valid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultModelA200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_getDefaultModelA200Valid + url: /http/payloads/default/A/response/200/valid + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Send a 200 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultModelA200None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_getDefaultModelA200None + url: /http/payloads/default/A/response/200/none + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: 'Send a 400 response with valid payload: {''statusCode'': ''400''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultModelA400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_getDefaultModelA400Valid + url: /http/payloads/default/A/response/400/valid + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Send a 400 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultModelA400None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_getDefaultModelA400None + url: /http/payloads/default/A/response/400/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with invalid payload: {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultNone200Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + isNullable: true + serializedName: multipleResponses_getDefaultNone200Invalid + url: /http/payloads/default/none/response/200/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: Send a 200 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultNone200None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + isNullable: true + serializedName: multipleResponses_getDefaultNone200None + url: /http/payloads/default/none/response/200/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 400 response with valid payload: {''statusCode'': ''400''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultNone400Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + isNullable: true + serializedName: multipleResponses_getDefaultNone400Invalid + url: /http/payloads/default/none/response/400/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: Send a 400 response with no payload + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDefaultNone400None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + isNullable: true + serializedName: multipleResponses_getDefaultNone400None + url: /http/payloads/default/none/response/400/none + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Send a 200 response with no payload, when a payload is expected - + client should return a null object of thde type for model A + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA200None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA200None + url: /http/payloads/200/A/response/200/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with payload {''statusCode'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA200Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA200Valid + url: /http/payloads/200/A/response/200/valid + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with invalid payload {''statusCodeInvalid'': ''200''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA200Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA200Invalid + url: /http/payloads/200/A/response/200/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Send a 400 response with no payload client should treat as an http + error with no error model + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA400None + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA400None + url: /http/payloads/200/A/response/400/none + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with payload {''statusCode'': ''400''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA400Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA400Valid + url: /http/payloads/200/A/response/400/valid + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 200 response with invalid payload {''statusCodeInvalid'': ''400''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA400Invalid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA400Invalid + url: /http/payloads/200/A/response/400/invalid + - defaultResponse: + isNullable: true + deprecated: false + description: 'Send a 202 response with payload {''statusCode'': ''202''}' + group: + fixed: false + raw: multipleResponses + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: get200ModelA202Valid + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: multipleResponses_get200ModelA202Valid + url: /http/payloads/200/A/response/202/valid + name: + fixed: false + raw: MultipleResponses + nameForProperty: MultipleResponses + typeName: + fixed: false diff --git a/test/Expected/lro/code-model-v1-yaml.yaml b/test/Expected/lro/code-model-v1-yaml.yaml new file mode 100644 index 0000000..7149458 --- /dev/null +++ b/test/Expected/lro/code-model-v1-yaml.yaml @@ -0,0 +1,7365 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Long-running Operation for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-external: true + name: + fixed: false + raw: CloudError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: CloudError +headerTypes: + - &ref_7 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putNoHeaderInRetry operation. + name: + fixed: false + raw: LROs-putNoHeaderInRetry-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/noheader/202/200/operationResults + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + serializedName: LROs-putNoHeaderInRetry-Headers + - &ref_8 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncRetrySucceeded operation. + name: + fixed: false + raw: LROs-putAsyncRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-putAsyncRetrySucceeded-Headers + - &ref_9 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncNoRetrySucceeded operation. + name: + fixed: false + raw: LROs-putAsyncNoRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/noretry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/noretry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: LROs-putAsyncNoRetrySucceeded-Headers + - &ref_10 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncRetryFailed operation. + name: + fixed: false + raw: LROs-putAsyncRetryFailed-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/failed/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/failed/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-putAsyncRetryFailed-Headers + - &ref_11 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncNoRetrycanceled operation. + name: + fixed: false + raw: LROs-putAsyncNoRetrycanceled-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/noretry/canceled/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/noretry/canceled/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: LROs-putAsyncNoRetrycanceled-Headers + - &ref_12 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncNoHeaderInRetry operation. + name: + fixed: false + raw: LROs-putAsyncNoHeaderInRetry-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + serializedName: LROs-putAsyncNoHeaderInRetry-Headers + - &ref_15 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteProvisioning202Accepted200Succeeded operation. + name: + fixed: false + raw: LROs-deleteProvisioning202Accepted200Succeeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/delete/provisioning/202/accepted/200/succeeded + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-deleteProvisioning202Accepted200Succeeded-Headers + - &ref_16 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteProvisioning202DeletingFailed200 operation. + name: + fixed: false + raw: LROs-deleteProvisioning202DeletingFailed200-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/delete/provisioning/202/deleting/200/failed + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-deleteProvisioning202DeletingFailed200-Headers + - &ref_17 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteProvisioning202Deletingcanceled200 operation. + name: + fixed: false + raw: LROs-deleteProvisioning202Deletingcanceled200-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/delete/provisioning/202/deleting/200/canceled + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-deleteProvisioning202Deletingcanceled200-Headers + - &ref_18 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for delete202Retry200 operation. + name: + fixed: false + raw: LROs-delete202Retry200-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/delete/202/retry/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-delete202Retry200-Headers + - &ref_19 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for delete202NoRetry204 operation. + name: + fixed: false + raw: LROs-delete202NoRetry204-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/delete/202/noretry/204 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-delete202NoRetry204-Headers + - &ref_20 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteNoHeaderInRetry operation. + name: + fixed: false + raw: LROs-deleteNoHeaderInRetry-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/put/noheader/202/204/operationresults + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: LROs-deleteNoHeaderInRetry-Headers + - &ref_21 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncNoHeaderInRetry operation. + name: + fixed: false + raw: LROs-deleteAsyncNoHeaderInRetry-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/put/noheader/202/204/operationresults + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: LROs-deleteAsyncNoHeaderInRetry-Headers + - &ref_22 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncRetrySucceeded operation. + name: + fixed: false + raw: LROs-deleteAsyncRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-deleteAsyncRetrySucceeded-Headers + - &ref_23 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncNoRetrySucceeded operation. + name: + fixed: false + raw: LROs-deleteAsyncNoRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/noretry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/noretry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-deleteAsyncNoRetrySucceeded-Headers + - &ref_24 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncRetryFailed operation. + name: + fixed: false + raw: LROs-deleteAsyncRetryFailed-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/retry/failed/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/retry/failed/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-deleteAsyncRetryFailed-Headers + - &ref_25 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncRetrycanceled operation. + name: + fixed: false + raw: LROs-deleteAsyncRetrycanceled-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/retry/canceled/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/retry/canceled/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-deleteAsyncRetrycanceled-Headers + - &ref_26 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post202Retry200 operation. + name: + fixed: false + raw: LROs-post202Retry200-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/post/202/retry/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-post202Retry200-Headers + - &ref_27 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post202NoRetry204 operation. + name: + fixed: false + raw: LROs-post202NoRetry204-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/post/202/noretry/204 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-post202NoRetry204-Headers + - &ref_28 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncRetrySucceeded operation. + name: + fixed: false + raw: LROs-postAsyncRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-postAsyncRetrySucceeded-Headers + - &ref_29 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncNoRetrySucceeded operation. + name: + fixed: false + raw: LROs-postAsyncNoRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-postAsyncNoRetrySucceeded-Headers + - &ref_30 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncRetryFailed operation. + name: + fixed: false + raw: LROs-postAsyncRetryFailed-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/failed/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/failed/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-postAsyncRetryFailed-Headers + - &ref_31 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncRetrycanceled operation. + name: + fixed: false + raw: LROs-postAsyncRetrycanceled-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/canceled/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/canceled/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROs-postAsyncRetrycanceled-Headers + - &ref_32 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncRelativeRetrySucceeded operation. + name: + fixed: false + raw: LRORetrys-putAsyncRelativeRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LRORetrys-putAsyncRelativeRetrySucceeded-Headers + - &ref_33 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteProvisioning202Accepted200Succeeded operation. + name: + fixed: false + raw: LRORetrys-deleteProvisioning202Accepted200Succeeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/delete/provisioning/202/accepted/200/succeeded + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LRORetrys-deleteProvisioning202Accepted200Succeeded-Headers + - &ref_34 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for delete202Retry200 operation. + name: + fixed: false + raw: LRORetrys-delete202Retry200-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/delete/202/retry/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LRORetrys-delete202Retry200-Headers + - &ref_35 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncRelativeRetrySucceeded operation. + name: + fixed: false + raw: LRORetrys-deleteAsyncRelativeRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/deleteasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/deleteasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LRORetrys-deleteAsyncRelativeRetrySucceeded-Headers + - &ref_36 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post202Retry200 operation. + name: + fixed: false + raw: LRORetrys-post202Retry200-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/post/202/retry/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LRORetrys-post202Retry200-Headers + - &ref_37 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncRelativeRetrySucceeded operation. + name: + fixed: false + raw: LRORetrys-postAsyncRelativeRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LRORetrys-postAsyncRelativeRetrySucceeded-Headers + - &ref_38 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncRelativeRetry400 operation. + name: + fixed: false + raw: LROSADs-putAsyncRelativeRetry400-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/nonretryerror/putasync/retry/operationResults/400 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/nonretryerror/putasync/retry/operationResults/400 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-putAsyncRelativeRetry400-Headers + - &ref_39 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteNonRetry400 operation. + name: + fixed: false + raw: LROSADs-deleteNonRetry400-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/delete/202/retry/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-deleteNonRetry400-Headers + - &ref_40 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for delete202NonRetry400 operation. + name: + fixed: false + raw: LROSADs-delete202NonRetry400-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/delete/202/retry/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-delete202NonRetry400-Headers + - &ref_41 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncRelativeRetry400 operation. + name: + fixed: false + raw: LROSADs-deleteAsyncRelativeRetry400-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/nonretryerror/deleteasync/retry/operationResults/400 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/nonretryerror/deleteasync/retry/operationResults/400 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-deleteAsyncRelativeRetry400-Headers + - &ref_42 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postNonRetry400 operation. + name: + fixed: false + raw: LROSADs-postNonRetry400-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/post/202/retry/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-postNonRetry400-Headers + - &ref_43 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post202NonRetry400 operation. + name: + fixed: false + raw: LROSADs-post202NonRetry400-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/retryerror/post/202/retry/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-post202NonRetry400-Headers + - &ref_44 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncRelativeRetry400 operation. + name: + fixed: false + raw: LROSADs-postAsyncRelativeRetry400-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/nonretryerror/putasync/retry/operationResults/400 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/nonretryerror/putasync/retry/operationResults/400 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-postAsyncRelativeRetry400-Headers + - &ref_45 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncRelativeRetryNoStatus operation. + name: + fixed: false + raw: LROSADs-putAsyncRelativeRetryNoStatus-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-putAsyncRelativeRetryNoStatus-Headers + - &ref_46 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncRelativeRetryNoStatusPayload operation. + name: + fixed: false + raw: LROSADs-putAsyncRelativeRetryNoStatusPayload-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-putAsyncRelativeRetryNoStatusPayload-Headers + - &ref_47 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncRelativeRetryNoStatus operation. + name: + fixed: false + raw: LROSADs-deleteAsyncRelativeRetryNoStatus-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/deleteasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-deleteAsyncRelativeRetryNoStatus-Headers + - &ref_48 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post202NoLocation operation. + name: + fixed: false + raw: LROSADs-post202NoLocation-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Location to poll for result status: will not be set' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-post202NoLocation-Headers + - &ref_49 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncRelativeRetryNoPayload operation. + name: + fixed: false + raw: LROSADs-postAsyncRelativeRetryNoPayload-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/error/putasync/retry/failed/operationResults/nopayload + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/error/putasync/retry/failed/operationResults/nopayload + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-postAsyncRelativeRetryNoPayload-Headers + - &ref_50 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncRelativeRetryInvalidHeader operation. + name: + fixed: false + raw: LROSADs-putAsyncRelativeRetryInvalidHeader-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-putAsyncRelativeRetryInvalidHeader-Headers + - &ref_51 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncRelativeRetryInvalidJsonPolling operation. + name: + fixed: false + raw: LROSADs-putAsyncRelativeRetryInvalidJsonPolling-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/failed/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/putasync/retry/failed/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-putAsyncRelativeRetryInvalidJsonPolling-Headers + - &ref_52 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for delete202RetryInvalidHeader operation. + name: + fixed: false + raw: LROSADs-delete202RetryInvalidHeader-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Location to poll for result status: will be set to /foo' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to /bar + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-delete202RetryInvalidHeader-Headers + - &ref_53 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncRelativeRetryInvalidHeader operation. + name: + fixed: false + raw: LROSADs-deleteAsyncRelativeRetryInvalidHeader-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Location to poll for result status: will be set to /foo' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Location to poll for result status: will be set to /foo' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to /bar + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-deleteAsyncRelativeRetryInvalidHeader-Headers + - &ref_54 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for deleteAsyncRelativeRetryInvalidJsonPolling operation. + name: + fixed: false + raw: LROSADs-deleteAsyncRelativeRetryInvalidJsonPolling-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/error/deleteasync/retry/failed/operationResults/invalidjsonpolling + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/error/deleteasync/retry/failed/operationResults/invalidjsonpolling + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-deleteAsyncRelativeRetryInvalidJsonPolling-Headers + - &ref_55 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post202RetryInvalidHeader operation. + name: + fixed: false + raw: LROSADs-post202RetryInvalidHeader-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Location to poll for result status: will be set to /foo' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to /bar + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-post202RetryInvalidHeader-Headers + - &ref_56 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncRelativeRetryInvalidHeader operation. + name: + fixed: false + raw: LROSADs-postAsyncRelativeRetryInvalidHeader-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Location to poll for result status: will be set to foo' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Location to poll for result status: will be set to foo' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to /bar + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-postAsyncRelativeRetryInvalidHeader-Headers + - &ref_57 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncRelativeRetryInvalidJsonPolling operation. + name: + fixed: false + raw: LROSADs-postAsyncRelativeRetryInvalidJsonPolling-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/error/postasync/retry/failed/operationResults/invalidjsonpolling + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/error/postasync/retry/failed/operationResults/invalidjsonpolling + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROSADs-postAsyncRelativeRetryInvalidJsonPolling-Headers + - &ref_58 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for putAsyncRetrySucceeded operation. + name: + fixed: false + raw: LROsCustomHeader-putAsyncRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/customheader/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/customheader/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROsCustomHeader-putAsyncRetrySucceeded-Headers + - &ref_59 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for post202Retry200 operation. + name: + fixed: false + raw: LROsCustomHeader-post202Retry200-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/customheader/post/202/retry/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROsCustomHeader-post202Retry200-Headers + - &ref_60 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for postAsyncRetrySucceeded operation. + name: + fixed: false + raw: LROsCustomHeader-postAsyncRetrySucceeded-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/customheader/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Azure-AsyncOperation + realPath: + - Azure-AsyncOperation + serializedName: Azure-AsyncOperation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Location to poll for result status: will be set to + /lro/customheader/putasync/retry/succeeded/operationResults/200 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of milliseconds until the next poll should be sent, will be + set to zero + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: Int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: Retry-After + realPath: + - Retry-After + serializedName: Retry-After + serializedName: LROsCustomHeader-postAsyncRetrySucceeded-Headers +modelTypes: + - *ref_0 + - &ref_1 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: Resource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Type + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Location + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Name + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: Resource + - &ref_13 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Sku + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: Sku + - &ref_2 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: Product_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Succeeded + serializedName: Succeeded + - name: Failed + serializedName: Failed + - name: canceled + serializedName: canceled + - name: Accepted + serializedName: Accepted + - name: Creating + serializedName: Creating + - name: Created + serializedName: Created + - name: Updating + serializedName: Updating + - name: Updated + serializedName: Updated + - name: Deleting + serializedName: Deleting + - name: Deleted + serializedName: Deleted + - name: OK + serializedName: OK + name: + fixed: false + raw: provisioningStateValues + realPath: + - provisioningStateValues + serializedName: provisioningStateValues + serializedName: Product_properties + - &ref_6 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + name: + fixed: false + raw: Product + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: Product + - &ref_3 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SubProduct_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Succeeded + serializedName: Succeeded + - name: Failed + serializedName: Failed + - name: canceled + serializedName: canceled + - name: Accepted + serializedName: Accepted + - name: Creating + serializedName: Creating + - name: Created + serializedName: Created + - name: Updating + serializedName: Updating + - name: Updated + serializedName: Updated + - name: Deleting + serializedName: Deleting + - name: Deleted + serializedName: Deleted + - name: OK + serializedName: OK + name: + fixed: false + raw: provisioningStateValues + realPath: + - provisioningStateValues + serializedName: provisioningStateValues + serializedName: SubProduct_properties + - &ref_14 + $type: CompositeType + baseModelType: &ref_4 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: SubResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sub Resource Id + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: SubResource + containsConstantProperties: false + name: + fixed: false + raw: SubProduct + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SubProduct + - *ref_4 + - &ref_5 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OperationResult_error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The error code for an operation failure + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The detailed arror message + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: OperationResult_error + - $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OperationResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The status of the request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Succeeded + serializedName: Succeeded + - name: Failed + serializedName: Failed + - name: canceled + serializedName: canceled + - name: Accepted + serializedName: Accepted + - name: Creating + serializedName: Creating + - name: Created + serializedName: Created + - name: Updating + serializedName: Updating + - name: Updated + serializedName: Updated + - name: Deleting + serializedName: Deleting + - name: Deleted + serializedName: Deleted + - name: OK + serializedName: OK + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_5 + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + serializedName: OperationResult +modelsName: Models +name: AutoRestLongRunningOperationTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that contains ProvisioningState=’Succeeded’. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put200Succeeded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROs_put200Succeeded + url: /lro/put/200/succeeded + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that does not contain + ProvisioningState=’Succeeded’. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put200SucceededNoState + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROs_put200SucceededNoState + url: /lro/put/200/succeeded/nostate + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 202 to the initial + request, with a location header that points to a polling URL that + returns a 200 and an entity that doesn't contains ProvisioningState + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put202Retry200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROs_put202Retry200 + url: /lro/put/202/retry/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 201 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + Polls return this value until the last poll returns a ‘200’ with + ProvisioningState=’Succeeded’ + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put201CreatingSucceeded200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_6 + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROs_put201CreatingSucceeded200 + url: /lro/put/201/creating/succeeded/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 201 to the initial + request, with an entity that contains ProvisioningState=’Updating’. + Polls return this value until the last poll returns a ‘200’ with + ProvisioningState=’Succeeded’ + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put200UpdatingSucceeded204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROs_put200UpdatingSucceeded204 + url: /lro/put/200/updating/succeeded/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 201 to the initial + request, with an entity that contains ProvisioningState=’Created’. + Polls return this value until the last poll returns a ‘200’ with + ProvisioningState=’Failed’ + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put201CreatingFailed200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_6 + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROs_put201CreatingFailed200 + url: /lro/put/201/created/failed/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 201 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’ + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put200Acceptedcanceled200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROs_put200Acceptedcanceled200 + url: /lro/put/200/accepted/canceled/200 + - defaultResponse: + body: *ref_0 + headers: *ref_7 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 202 to the initial request + with location header. Subsequent calls to operation status do not + contain location header. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNoHeaderInRetry + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_6 + headers: *ref_7 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_7 + isNullable: true + serializedName: LROs_putNoHeaderInRetry + url: /lro/put/noheader/202/200 + - defaultResponse: + body: *ref_0 + headers: *ref_8 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + Poll the endpoint indicated in the Azure-AsyncOperation header for + operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncRetrySucceeded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_8 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_8 + isNullable: true + serializedName: LROs_putAsyncRetrySucceeded + url: /lro/putasync/retry/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_9 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + Poll the endpoint indicated in the Azure-AsyncOperation header for + operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncNoRetrySucceeded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_9 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_9 + isNullable: true + serializedName: LROs_putAsyncNoRetrySucceeded + url: /lro/putasync/noretry/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_10 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + Poll the endpoint indicated in the Azure-AsyncOperation header for + operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncRetryFailed + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_10 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_10 + isNullable: true + serializedName: LROs_putAsyncRetryFailed + url: /lro/putasync/retry/failed + - defaultResponse: + body: *ref_0 + headers: *ref_11 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + Poll the endpoint indicated in the Azure-AsyncOperation header for + operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncNoRetrycanceled + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_11 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_11 + isNullable: true + serializedName: LROs_putAsyncNoRetrycanceled + url: /lro/putasync/noretry/canceled + - defaultResponse: + body: *ref_0 + headers: *ref_12 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 202 to the initial request + with Azure-AsyncOperation header. Subsequent calls to operation status + do not contain Azure-AsyncOperation header. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncNoHeaderInRetry + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_6 + headers: *ref_12 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_12 + isNullable: true + serializedName: LROs_putAsyncNoHeaderInRetry + url: /lro/putasync/noheader/201/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Long running put request with non resource. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNonResource + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: sku to put + extensions: + x-ms-requestBody-name: sku + isConstant: false + isRequired: false + location: body + modelType: *ref_13 + name: + fixed: false + raw: sku + serializedName: sku + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_13 + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: LROs_putNonResource + url: /lro/putnonresource/202/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Long running put request with non resource. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncNonResource + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sku to put + extensions: + x-ms-requestBody-name: sku + isConstant: false + isRequired: false + location: body + modelType: *ref_13 + name: + fixed: false + raw: sku + serializedName: sku + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_13 + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: LROs_putAsyncNonResource + url: /lro/putnonresourceasync/202/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Long running put request with sub resource. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putSubResource + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sub Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_14 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_14 + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: LROs_putSubResource + url: /lro/putsubresource/202/200 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Long running put request with sub resource. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncSubResource + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sub Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_14 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_14 + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: LROs_putAsyncSubResource + url: /lro/putsubresourceasync/202/200 + - defaultResponse: + body: *ref_0 + headers: *ref_15 + isNullable: true + deprecated: false + 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’ + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteProvisioning202Accepted200Succeeded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_6 + headers: *ref_15 + isNullable: true + OK: + body: *ref_6 + headers: *ref_15 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_15 + isNullable: true + serializedName: LROs_deleteProvisioning202Accepted200Succeeded + url: /lro/delete/provisioning/202/accepted/200/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_16 + isNullable: true + deprecated: false + 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=’Failed’ + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteProvisioning202DeletingFailed200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_6 + headers: *ref_16 + isNullable: true + OK: + body: *ref_6 + headers: *ref_16 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_16 + isNullable: true + serializedName: LROs_deleteProvisioning202DeletingFailed200 + url: /lro/delete/provisioning/202/deleting/200/failed + - defaultResponse: + body: *ref_0 + headers: *ref_17 + isNullable: true + deprecated: false + 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’ + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteProvisioning202Deletingcanceled200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_6 + headers: *ref_17 + isNullable: true + OK: + body: *ref_6 + headers: *ref_17 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_17 + isNullable: true + serializedName: LROs_deleteProvisioning202Deletingcanceled200 + url: /lro/delete/provisioning/202/deleting/200/canceled + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Long running delete succeeds and returns right away + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete204Succeeded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: LROs_delete204Succeeded + url: /lro/delete/204/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_18 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. Polls return this value until the last poll returns a ‘200’ + with ProvisioningState=’Succeeded’ + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete202Retry200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_18 + isNullable: true + OK: + body: *ref_6 + headers: *ref_18 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_18 + isNullable: true + serializedName: LROs_delete202Retry200 + url: /lro/delete/202/retry/200 + - defaultResponse: + body: *ref_0 + headers: *ref_19 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. Polls return this value until the last poll returns a ‘200’ + with ProvisioningState=’Succeeded’ + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete202NoRetry204 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_19 + isNullable: true + OK: + body: *ref_6 + headers: *ref_19 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_19 + isNullable: true + serializedName: LROs_delete202NoRetry204 + url: /lro/delete/202/noretry/204 + - defaultResponse: + body: *ref_0 + headers: *ref_20 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a location header in the + initial request. Subsequent calls to operation status do not contain + location header. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteNoHeaderInRetry + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_20 + isNullable: true + NoContent: + headers: *ref_20 + isNullable: true + returnType: + headers: *ref_20 + isNullable: true + serializedName: LROs_deleteNoHeaderInRetry + url: /lro/delete/noheader + - defaultResponse: + body: *ref_0 + headers: *ref_21 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns an Azure-AsyncOperation + header in the initial request. Subsequent calls to operation status do + not contain Azure-AsyncOperation header. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncNoHeaderInRetry + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_21 + isNullable: true + NoContent: + headers: *ref_21 + isNullable: true + returnType: + headers: *ref_21 + isNullable: true + serializedName: LROs_deleteAsyncNoHeaderInRetry + url: /lro/deleteasync/noheader/202/204 + - defaultResponse: + body: *ref_0 + headers: *ref_22 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. Poll the endpoint indicated in the Azure-AsyncOperation + header for operation status + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncRetrySucceeded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_22 + isNullable: true + returnType: + headers: *ref_22 + isNullable: true + serializedName: LROs_deleteAsyncRetrySucceeded + url: /lro/deleteasync/retry/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_23 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. Poll the endpoint indicated in the Azure-AsyncOperation + header for operation status + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncNoRetrySucceeded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_23 + isNullable: true + returnType: + headers: *ref_23 + isNullable: true + serializedName: LROs_deleteAsyncNoRetrySucceeded + url: /lro/deleteasync/noretry/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_24 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. Poll the endpoint indicated in the Azure-AsyncOperation + header for operation status + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncRetryFailed + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_24 + isNullable: true + returnType: + headers: *ref_24 + isNullable: true + serializedName: LROs_deleteAsyncRetryFailed + url: /lro/deleteasync/retry/failed + - defaultResponse: + body: *ref_0 + headers: *ref_25 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. Poll the endpoint indicated in the Azure-AsyncOperation + header for operation status + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncRetrycanceled + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_25 + isNullable: true + returnType: + headers: *ref_25 + isNullable: true + serializedName: LROs_deleteAsyncRetrycanceled + url: /lro/deleteasync/retry/canceled + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns a 202 to the initial + request, with 'Location' header. Poll returns a 200 with a response + body after success. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post200WithPayload + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_13 + isNullable: true + OK: + body: *ref_13 + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: LROs_post200WithPayload + url: /lro/post/payload/200 + - defaultResponse: + body: *ref_0 + headers: *ref_26 + isNullable: true + deprecated: false + description: >- + 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 + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post202Retry200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_26 + isNullable: true + returnType: + headers: *ref_26 + isNullable: true + serializedName: LROs_post202Retry200 + url: /lro/post/202/retry/200 + - defaultResponse: + body: *ref_0 + headers: *ref_27 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns a 202 to the initial + request, with 'Location' header, 204 with noresponse body after + success + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post202NoRetry204 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_6 + headers: *ref_27 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_27 + isNullable: true + serializedName: LROs_post202NoRetry204 + url: /lro/post/202/noretry/204 + - defaultResponse: + body: *ref_0 + headers: *ref_28 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns 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 + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncRetrySucceeded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_28 + isNullable: true + OK: + body: *ref_6 + headers: *ref_28 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_28 + isNullable: true + serializedName: LROs_postAsyncRetrySucceeded + url: /lro/postasync/retry/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_29 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns 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 + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncNoRetrySucceeded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_29 + isNullable: true + OK: + body: *ref_6 + headers: *ref_29 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_29 + isNullable: true + serializedName: LROs_postAsyncNoRetrySucceeded + url: /lro/postasync/noretry/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_30 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns 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 + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncRetryFailed + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_30 + isNullable: true + returnType: + headers: *ref_30 + isNullable: true + serializedName: LROs_postAsyncRetryFailed + url: /lro/postasync/retry/failed + - defaultResponse: + body: *ref_0 + headers: *ref_31 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns 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 + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncRetrycanceled + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_31 + isNullable: true + returnType: + headers: *ref_31 + isNullable: true + serializedName: LROs_postAsyncRetrycanceled + url: /lro/postasync/retry/canceled + name: + fixed: false + raw: LROs + nameForProperty: LROs + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 500, then a 201 to the + initial request, with an entity that contains + ProvisioningState=’Creating’. Polls return this value until the last + poll returns a ‘200’ with ProvisioningState=’Succeeded’ + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LRORetrys + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put201CreatingSucceeded200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_6 + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LRORetrys_put201CreatingSucceeded200 + url: /lro/retryerror/put/201/creating/succeeded/200 + - defaultResponse: + body: *ref_0 + headers: *ref_32 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 500, then a 200 to the + initial request, with an entity that contains + ProvisioningState=’Creating’. Poll the endpoint indicated in the + Azure-AsyncOperation header for operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LRORetrys + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncRelativeRetrySucceeded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_32 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_32 + isNullable: true + serializedName: LRORetrys_putAsyncRelativeRetrySucceeded + url: /lro/retryerror/putasync/retry/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_33 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 500, then 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’ + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LRORetrys + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteProvisioning202Accepted200Succeeded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_6 + headers: *ref_33 + isNullable: true + OK: + body: *ref_6 + headers: *ref_33 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_33 + isNullable: true + serializedName: LRORetrys_deleteProvisioning202Accepted200Succeeded + url: /lro/retryerror/delete/provisioning/202/accepted/200/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_34 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 500, then a 202 to the + initial request. Polls return this value until the last poll returns a + ‘200’ with ProvisioningState=’Succeeded’ + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LRORetrys + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete202Retry200 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_34 + isNullable: true + returnType: + headers: *ref_34 + isNullable: true + serializedName: LRORetrys_delete202Retry200 + url: /lro/retryerror/delete/202/retry/200 + - defaultResponse: + body: *ref_0 + headers: *ref_35 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 500, then a 202 to the + initial request. Poll the endpoint indicated in the + Azure-AsyncOperation header for operation status + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LRORetrys + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncRelativeRetrySucceeded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_35 + isNullable: true + returnType: + headers: *ref_35 + isNullable: true + serializedName: LRORetrys_deleteAsyncRelativeRetrySucceeded + url: /lro/retryerror/deleteasync/retry/succeeded + - defaultResponse: + body: *ref_0 + headers: *ref_36 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns a 500, then a 202 to the + initial request, with 'Location' and 'Retry-After' headers, Polls + return a 200 with a response body after success + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LRORetrys + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post202Retry200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_36 + isNullable: true + returnType: + headers: *ref_36 + isNullable: true + serializedName: LRORetrys_post202Retry200 + url: /lro/retryerror/post/202/retry/200 + - defaultResponse: + body: *ref_0 + headers: *ref_37 + isNullable: true + deprecated: false + 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 + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LRORetrys + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncRelativeRetrySucceeded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_37 + isNullable: true + returnType: + headers: *ref_37 + isNullable: true + serializedName: LRORetrys_postAsyncRelativeRetrySucceeded + url: /lro/retryerror/postasync/retry/succeeded + name: + fixed: false + raw: LRORetrys + nameForProperty: LRORetrys + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Long running put request, service returns a 400 to the initial request' + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNonRetry400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_6 + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROSADs_putNonRetry400 + url: /lro/nonretryerror/put/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a Product with + 'ProvisioningState' = 'Creating' and 201 response code + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNonRetry201Creating400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_6 + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROSADs_putNonRetry201Creating400 + url: /lro/nonretryerror/put/201/creating/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a Product with + 'ProvisioningState' = 'Creating' and 201 response code + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putNonRetry201Creating400InvalidJson + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_6 + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROSADs_putNonRetry201Creating400InvalidJson + url: /lro/nonretryerror/put/201/creating/400/invalidjson + - defaultResponse: + body: *ref_0 + headers: *ref_38 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 with + ProvisioningState=’Creating’. Poll the endpoint indicated in the + Azure-AsyncOperation header for operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncRelativeRetry400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_38 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_38 + isNullable: true + serializedName: LROSADs_putAsyncRelativeRetry400 + url: /lro/nonretryerror/putasync/retry/400 + - defaultResponse: + body: *ref_0 + headers: *ref_39 + isNullable: true + deprecated: false + description: 'Long running delete request, service returns a 400 with an error body' + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteNonRetry400 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_39 + isNullable: true + returnType: + headers: *ref_39 + isNullable: true + serializedName: LROSADs_deleteNonRetry400 + url: /lro/nonretryerror/delete/400 + - defaultResponse: + body: *ref_0 + headers: *ref_40 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 with a location + header + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete202NonRetry400 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_40 + isNullable: true + returnType: + headers: *ref_40 + isNullable: true + serializedName: LROSADs_delete202NonRetry400 + url: /lro/nonretryerror/delete/202/retry/400 + - defaultResponse: + body: *ref_0 + headers: *ref_41 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. Poll the endpoint indicated in the Azure-AsyncOperation + header for operation status + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncRelativeRetry400 + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_41 + isNullable: true + returnType: + headers: *ref_41 + isNullable: true + serializedName: LROSADs_deleteAsyncRelativeRetry400 + url: /lro/nonretryerror/deleteasync/retry/400 + - defaultResponse: + body: *ref_0 + headers: *ref_42 + isNullable: true + deprecated: false + description: 'Long running post request, service returns a 400 with no error body' + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postNonRetry400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_42 + isNullable: true + returnType: + headers: *ref_42 + isNullable: true + serializedName: LROSADs_postNonRetry400 + url: /lro/nonretryerror/post/400 + - defaultResponse: + body: *ref_0 + headers: *ref_43 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns a 202 with a location + header + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post202NonRetry400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_43 + isNullable: true + returnType: + headers: *ref_43 + isNullable: true + serializedName: LROSADs_post202NonRetry400 + url: /lro/nonretryerror/post/202/retry/400 + - defaultResponse: + body: *ref_0 + headers: *ref_44 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns a 202 to the initial + request Poll the endpoint indicated in the Azure-AsyncOperation header + for operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncRelativeRetry400 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_44 + isNullable: true + returnType: + headers: *ref_44 + isNullable: true + serializedName: LROSADs_postAsyncRelativeRetry400 + url: /lro/nonretryerror/postasync/retry/400 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 201 to the initial request + with no payload + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putError201NoProvisioningStatePayload + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_6 + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROSADs_putError201NoProvisioningStatePayload + url: /lro/error/put/201/noprovisioningstatepayload + - defaultResponse: + body: *ref_0 + headers: *ref_45 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + Poll the endpoint indicated in the Azure-AsyncOperation header for + operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncRelativeRetryNoStatus + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_45 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_45 + isNullable: true + serializedName: LROSADs_putAsyncRelativeRetryNoStatus + url: /lro/error/putasync/retry/nostatus + - defaultResponse: + body: *ref_0 + headers: *ref_46 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + Poll the endpoint indicated in the Azure-AsyncOperation header for + operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncRelativeRetryNoStatusPayload + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_46 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_46 + isNullable: true + serializedName: LROSADs_putAsyncRelativeRetryNoStatusPayload + url: /lro/error/putasync/retry/nostatuspayload + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 204 to the initial + request, indicating success. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete204Succeeded + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: LROSADs_delete204Succeeded + url: /lro/error/delete/204/nolocation + - defaultResponse: + body: *ref_0 + headers: *ref_47 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. Poll the endpoint indicated in the Azure-AsyncOperation + header for operation status + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncRelativeRetryNoStatus + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_47 + isNullable: true + returnType: + headers: *ref_47 + isNullable: true + serializedName: LROSADs_deleteAsyncRelativeRetryNoStatus + url: /lro/error/deleteasync/retry/nostatus + - defaultResponse: + body: *ref_0 + headers: *ref_48 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns a 202 to the initial + request, without a location header. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post202NoLocation + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_48 + isNullable: true + returnType: + headers: *ref_48 + isNullable: true + serializedName: LROSADs_post202NoLocation + url: /lro/error/post/202/nolocation + - defaultResponse: + body: *ref_0 + headers: *ref_49 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns 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 + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncRelativeRetryNoPayload + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_49 + isNullable: true + returnType: + headers: *ref_49 + isNullable: true + serializedName: LROSADs_postAsyncRelativeRetryNoPayload + url: /lro/error/postasync/retry/nopayload + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that is not a valid json + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put200InvalidJson + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROSADs_put200InvalidJson + url: /lro/error/put/200/invalidjson + - defaultResponse: + body: *ref_0 + headers: *ref_50 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + The endpoint indicated in the Azure-AsyncOperation header is invalid. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncRelativeRetryInvalidHeader + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_50 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_50 + isNullable: true + serializedName: LROSADs_putAsyncRelativeRetryInvalidHeader + url: /lro/error/putasync/retry/invalidheader + - defaultResponse: + body: *ref_0 + headers: *ref_51 + isNullable: true + deprecated: false + description: >- + Long running put request, service returns a 200 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + Poll the endpoint indicated in the Azure-AsyncOperation header for + operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncRelativeRetryInvalidJsonPolling + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_51 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_51 + isNullable: true + serializedName: LROSADs_putAsyncRelativeRetryInvalidJsonPolling + url: /lro/error/putasync/retry/invalidjsonpolling + - defaultResponse: + body: *ref_0 + headers: *ref_52 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request receing a reponse with an invalid 'Location' and 'Retry-After' + headers + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: delete202RetryInvalidHeader + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_52 + isNullable: true + returnType: + headers: *ref_52 + isNullable: true + serializedName: LROSADs_delete202RetryInvalidHeader + url: /lro/error/delete/202/retry/invalidheader + - defaultResponse: + body: *ref_0 + headers: *ref_53 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. The endpoint indicated in the Azure-AsyncOperation header is + invalid + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncRelativeRetryInvalidHeader + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_53 + isNullable: true + returnType: + headers: *ref_53 + isNullable: true + serializedName: LROSADs_deleteAsyncRelativeRetryInvalidHeader + url: /lro/error/deleteasync/retry/invalidheader + - defaultResponse: + body: *ref_0 + headers: *ref_54 + isNullable: true + deprecated: false + description: >- + Long running delete request, service returns a 202 to the initial + request. Poll the endpoint indicated in the Azure-AsyncOperation + header for operation status + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: deleteAsyncRelativeRetryInvalidJsonPolling + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_54 + isNullable: true + returnType: + headers: *ref_54 + isNullable: true + serializedName: LROSADs_deleteAsyncRelativeRetryInvalidJsonPolling + url: /lro/error/deleteasync/retry/invalidjsonpolling + - defaultResponse: + body: *ref_0 + headers: *ref_55 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns a 202 to the initial + request, with invalid 'Location' and 'Retry-After' headers. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post202RetryInvalidHeader + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_55 + isNullable: true + returnType: + headers: *ref_55 + isNullable: true + serializedName: LROSADs_post202RetryInvalidHeader + url: /lro/error/post/202/retry/invalidheader + - defaultResponse: + body: *ref_0 + headers: *ref_56 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns a 202 to the initial + request, with an entity that contains ProvisioningState=’Creating’. + The endpoint indicated in the Azure-AsyncOperation header is invalid. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncRelativeRetryInvalidHeader + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_56 + isNullable: true + returnType: + headers: *ref_56 + isNullable: true + serializedName: LROSADs_postAsyncRelativeRetryInvalidHeader + url: /lro/error/postasync/retry/invalidheader + - defaultResponse: + body: *ref_0 + headers: *ref_57 + isNullable: true + deprecated: false + description: >- + Long running post request, service returns 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 + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROSADs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncRelativeRetryInvalidJsonPolling + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_57 + isNullable: true + returnType: + headers: *ref_57 + isNullable: true + serializedName: LROSADs_postAsyncRelativeRetryInvalidJsonPolling + url: /lro/error/postasync/retry/invalidjsonpolling + name: + fixed: false + raw: LROSADs + nameForProperty: LROSADs + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + headers: *ref_58 + isNullable: true + deprecated: false + description: >- + x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is + required message header for all requests. Long running put request, + service returns a 200 to the initial request, with an entity that + contains ProvisioningState=’Creating’. Poll the endpoint indicated in + the Azure-AsyncOperation header for operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROsCustomHeader + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putAsyncRetrySucceeded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_6 + headers: *ref_58 + isNullable: true + returnType: + body: *ref_6 + headers: *ref_58 + isNullable: true + serializedName: LROsCustomHeader_putAsyncRetrySucceeded + url: /lro/customheader/putasync/retry/succeeded + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is + required message header for all requests. Long running put request, + service returns a 201 to the initial request, with an entity that + contains ProvisioningState=’Creating’. Polls return this value until + the last poll returns a ‘200’ with ProvisioningState=’Succeeded’ + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROsCustomHeader + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: put201CreatingSucceeded200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_6 + isNullable: true + OK: + body: *ref_6 + isNullable: true + returnType: + body: *ref_6 + isNullable: true + serializedName: LROsCustomHeader_put201CreatingSucceeded200 + url: /lro/customheader/put/201/creating/succeeded/200 + - defaultResponse: + body: *ref_0 + headers: *ref_59 + isNullable: true + deprecated: false + 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 + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROsCustomHeader + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: post202Retry200 + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_59 + isNullable: true + returnType: + headers: *ref_59 + isNullable: true + serializedName: LROsCustomHeader_post202Retry200 + url: /lro/customheader/post/202/retry/200 + - defaultResponse: + body: *ref_0 + headers: *ref_60 + isNullable: true + deprecated: false + 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 an entity that + contains ProvisioningState=’Creating’. Poll the endpoint indicated in + the Azure-AsyncOperation header for operation status + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '0' + group: + fixed: false + raw: LROsCustomHeader + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postAsyncRetrySucceeded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product to put + extensions: + x-ms-requestBody-name: product + isConstant: false + isRequired: false + location: body + modelType: *ref_6 + name: + fixed: false + raw: product + serializedName: product + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_60 + isNullable: true + returnType: + headers: *ref_60 + isNullable: true + serializedName: LROsCustomHeader_postAsyncRetrySucceeded + url: /lro/customheader/postasync/retry/succeeded + name: + fixed: false + raw: LROsCustomHeader + nameForProperty: LROsCustomHeader + typeName: + fixed: false diff --git a/test/Expected/model-flattening/code-model-v1-yaml.yaml b/test/Expected/model-flattening/code-model-v1-yaml.yaml new file mode 100644 index 0000000..ff1cf3f --- /dev/null +++ b/test/Expected/model-flattening/code-model-v1-yaml.yaml @@ -0,0 +1,1166 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Resource Flattening for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: parentError + realPath: + - parentError + serializedName: parentError + serializedName: Error +modelTypes: + - *ref_0 + - &ref_1 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Resource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Type + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Location + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Name + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: Resource + - &ref_2 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: FlattenedProduct_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: p.name + realPath: + - p.name + serializedName: p.name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Succeeded + serializedName: Succeeded + - name: Failed + serializedName: Failed + - name: canceled + serializedName: canceled + - name: Accepted + serializedName: Accepted + - name: Creating + serializedName: Creating + - name: Created + serializedName: Created + - name: Updating + serializedName: Updating + - name: Updated + serializedName: Updated + - name: Deleting + serializedName: Deleting + - name: Deleted + serializedName: Deleted + - name: OK + serializedName: OK + name: + fixed: false + raw: provisioningStateValues + realPath: + - provisioningStateValues + serializedName: provisioningStateValues + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + serializedName: FlattenedProduct_properties + - &ref_3 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: Flattened product. + externalDocsUrl: 'http://tempuri.org' + name: + fixed: false + raw: FlattenedProduct + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: FlattenedProduct + - &ref_13 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ResourceCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: productresource + realPath: + - productresource + serializedName: productresource + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_3 + name: + fixed: false + name: + fixed: false + raw: arrayofresources + realPath: + - arrayofresources + serializedName: arrayofresources + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_3 + name: + fixed: false + raw: dictionaryofresources + realPath: + - dictionaryofresources + serializedName: dictionaryofresources + serializedName: ResourceCollection + - &ref_5 + $type: CompositeType + containsConstantProperties: false + documentation: The product documentation. + name: + fixed: false + raw: BaseProduct + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unique identifier representing a specific product for a given + latitude & longitude. For example, uberX in San Francisco will have + a different product_id than uberX in Los Angeles. + extensions: + x-ms-client-name: productId + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: base_product_id + realPath: + - base_product_id + serializedName: base_product_id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Description of product. + extensions: + x-ms-client-name: description + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: base_product_description + realPath: + - base_product_description + serializedName: base_product_description + serializedName: BaseProduct + - &ref_4 + $type: CompositeType + baseModelType: &ref_7 + $type: CompositeType + containsConstantProperties: false + documentation: The Generic URL. + name: + fixed: false + raw: GenericUrl + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Generic URL value. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: generic_value + realPath: + - generic_value + serializedName: generic_value + serializedName: GenericUrl + containsConstantProperties: false + documentation: The product URL. + name: + fixed: false + raw: ProductUrl + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: URL value. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: '@odata.value' + realPath: + - '@odata.value' + serializedName: '@odata.value' + serializedName: ProductUrl + - &ref_6 + $type: CompositeType + containsConstantProperties: true + documentation: The product documentation. + name: + fixed: false + raw: SimpleProductProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Display name of product. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: max_product_display_name + realPath: + - max_product_display_name + serializedName: max_product_display_name + - collectionFormat: none + defaultValue: + fixed: false + raw: Large + documentation: + fixed: false + raw: 'Capacity of product. For example, 4 people.' + extensions: + x-ms-client-name: capacity + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: max_product_capacity + realPath: + - max_product_capacity + serializedName: max_product_capacity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_4 + name: + fixed: false + raw: max_product_image + realPath: + - max_product_image + serializedName: max_product_image + serializedName: SimpleProductProperties + - &ref_14 + $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: true + documentation: The product documentation. + name: + fixed: false + raw: SimpleProduct + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_6 + name: + fixed: false + raw: details + realPath: + - details + serializedName: details + serializedName: SimpleProduct + - *ref_7 + - &ref_8 + $type: CompositeType + containsConstantProperties: false + documentation: The wrapped produc. + name: + fixed: false + raw: WrappedProduct + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the product value + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: WrappedProduct + - &ref_10 + $type: CompositeType + containsConstantProperties: false + documentation: The wrapped produc. + name: + fixed: false + raw: ProductWrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_8 + name: + fixed: false + raw: property + realPath: + - property + serializedName: property + serializedName: ProductWrapper +modelsName: Models +name: AutoRestResourceFlatteningTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put External Resource as an Array + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putArray + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as an Array to put + extensions: + x-ms-requestBody-name: ResourceArray + isConstant: false + isRequired: false + location: body + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: ResourceArray + serializedName: ResourceArray + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putArray + url: /model-flatten/array + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get External Resource as an Array + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getArray + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_9 + $type: SequenceType + elementType: *ref_3 + name: + fixed: false + isNullable: true + returnType: + body: *ref_9 + isNullable: true + serializedName: getArray + url: /model-flatten/array + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + No need to have a route in Express server for this operation. Used to + verify the type flattened is not removed if it's referenced in an + array + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putWrappedArray + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as an Array to put + extensions: + x-ms-requestBody-name: ResourceArray + isConstant: false + isRequired: false + location: body + modelType: + $type: SequenceType + elementType: *ref_8 + name: + fixed: false + name: + fixed: false + raw: ResourceArray + serializedName: ResourceArray + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putWrappedArray + url: /model-flatten/wrappedarray + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + No need to have a route in Express server for this operation. Used to + verify the type flattened is not removed if it's referenced in an + array + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getWrappedArray + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_11 + $type: SequenceType + elementType: *ref_10 + name: + fixed: false + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: getWrappedArray + url: /model-flatten/wrappedarray + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put External Resource as a Dictionary + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putDictionary + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as a Dictionary to put + extensions: + x-ms-requestBody-name: ResourceDictionary + isConstant: false + isRequired: false + location: body + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_3 + name: + fixed: false + raw: ResourceDictionary + serializedName: ResourceDictionary + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putDictionary + url: /model-flatten/dictionary + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get External Resource as a Dictionary + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getDictionary + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_12 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_3 + isNullable: true + returnType: + body: *ref_12 + isNullable: true + serializedName: getDictionary + url: /model-flatten/dictionary + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put External Resource as a ResourceCollection + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putResourceCollection + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: External Resource as a ResourceCollection to put + extensions: + x-ms-requestBody-name: ResourceComplexObject + isConstant: false + isRequired: false + location: body + modelType: *ref_13 + name: + fixed: false + raw: ResourceComplexObject + serializedName: ResourceComplexObject + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: putResourceCollection + url: /model-flatten/resourcecollection + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get External Resource as a ResourceCollection + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getResourceCollection + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_13 + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: getResourceCollection + url: /model-flatten/resourcecollection + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put Simple Product with client flattening true on the model + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putSimpleProduct + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple body product to put + extensions: + x-ms-requestBody-name: SimpleBodyProduct + isConstant: false + isRequired: false + location: body + modelType: *ref_14 + name: + fixed: false + raw: SimpleBodyProduct + serializedName: SimpleBodyProduct + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_14 + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: putSimpleProduct + url: /model-flatten/customFlattening + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Put Flattened Simple Product with client flattening true on the + parameter + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postFlattenedSimpleProduct + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple body product to post + extensions: + x-ms-client-flatten: true + x-ms-requestBody-name: SimpleBodyProduct + isConstant: false + isRequired: false + location: body + modelType: *ref_14 + name: + fixed: false + raw: SimpleBodyProduct + serializedName: SimpleBodyProduct + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_14 + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: postFlattenedSimpleProduct + url: /model-flatten/customFlattening + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Put Simple Product with client flattening true on the model + extensions: + x-ms-requestBody-index: '0' + externalDocsUrl: 'http://tempuri.org' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putSimpleProductWithGrouping + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Simple body product to put + extensions: + x-ms-client-flatten: true + x-ms-parameter-grouping: + name: flatten-parameter-group + x-ms-requestBody-name: SimpleBodyProduct + isConstant: false + isRequired: false + location: body + modelType: *ref_14 + name: + fixed: false + raw: SimpleBodyProduct + serializedName: SimpleBodyProduct + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product name with value 'groupproduct' + extensions: + x-ms-parameter-grouping: + name: flatten-parameter-group + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_14 + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: putSimpleProductWithGrouping + url: '/model-flatten/customFlattening/parametergrouping/{name}/' + name: + fixed: false + raw: '' + nameForProperty: AutoRestResourceFlatteningTestService + typeName: + fixed: false diff --git a/test/Expected/paging/code-model-v1-yaml.yaml b/test/Expected/paging/code-model-v1-yaml.yaml new file mode 100644 index 0000000..1bbca1c --- /dev/null +++ b/test/Expected/paging/code-model-v1-yaml.yaml @@ -0,0 +1,1066 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Long-running Operation for AutoRest +modelTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Product_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: Product_properties + - &ref_1 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Product + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: Product + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ProductResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: values + realPath: + - values + serializedName: values + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ProductResult + - &ref_3 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OdataProductResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: values + realPath: + - values + serializedName: values + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + serializedName: OdataProductResult + - $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OperationResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The status of the request + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: '' + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Succeeded + serializedName: Succeeded + - name: Failed + serializedName: Failed + - name: canceled + serializedName: canceled + - name: Accepted + serializedName: Accepted + - name: Creating + serializedName: Creating + - name: Created + serializedName: Created + - name: Updating + serializedName: Updating + - name: Updated + serializedName: Updated + - name: Deleting + serializedName: Deleting + - name: Deleted + serializedName: Deleted + - name: OK + serializedName: OK + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + serializedName: OperationResult +modelsName: Models +name: AutoRestPagingTestService +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: A paging operation that finishes on the first call without a nextlink + extensions: + x-ms-pageable: + itemName: values + nextLinkName: nextLink + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSinglePages + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Paging_getSinglePages + url: /paging/single + - defaultResponse: + isNullable: true + deprecated: false + description: A paging operation that includes a nextLink that has 10 pages + extensions: + x-ms-pageable: + itemName: values + nextLinkName: nextLink + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMultiplePages + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the maximum number of items to return in the response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + Sets the maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Paging_getMultiplePages + url: /paging/multiple + - defaultResponse: + isNullable: true + deprecated: false + description: >- + A paging operation that includes a nextLink in odata format that has + 10 pages + extensions: + x-ms-pageable: + itemName: values + nextLinkName: odata.nextLink + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getOdataMultiplePages + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the maximum number of items to return in the response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + Sets the maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_3 + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: Paging_getOdataMultiplePages + url: /paging/multiple/odata + - defaultResponse: + isNullable: true + deprecated: false + description: A paging operation that includes a nextLink that has 10 pages + extensions: + x-ms-pageable: + itemName: values + nextLinkName: nextLink + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMultiplePagesWithOffset + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the maximum number of items to return in the response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Offset of return value + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: offset + serializedName: offset + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + Sets the maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Paging_getMultiplePagesWithOffset + url: '/paging/multiple/withpath/{offset}' + - defaultResponse: + isNullable: true + deprecated: false + description: >- + A paging operation that fails on the first call with 500 and then + retries and then get a response including a nextLink that has 10 pages + extensions: + x-ms-pageable: + itemName: values + nextLinkName: nextLink + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMultiplePagesRetryFirst + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Paging_getMultiplePagesRetryFirst + url: /paging/multiple/retryfirst + - defaultResponse: + isNullable: true + deprecated: false + description: >- + A paging operation that includes a nextLink that has 10 pages, of + which the 2nd call fails first with 500. The client should retry and + finish all 10 pages eventually. + extensions: + x-ms-pageable: + itemName: values + nextLinkName: nextLink + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMultiplePagesRetrySecond + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Paging_getMultiplePagesRetrySecond + url: /paging/multiple/retrysecond + - defaultResponse: + isNullable: true + deprecated: false + description: A paging operation that receives a 400 on the first call + extensions: + x-ms-pageable: + itemName: values + nextLinkName: nextLink + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSinglePagesFailure + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Paging_getSinglePagesFailure + url: /paging/single/failure + - defaultResponse: + isNullable: true + deprecated: false + description: A paging operation that receives a 400 on the second call + extensions: + x-ms-pageable: + itemName: values + nextLinkName: nextLink + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMultiplePagesFailure + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Paging_getMultiplePagesFailure + url: /paging/multiple/failure + - defaultResponse: + isNullable: true + deprecated: false + description: A paging operation that receives an invalid nextLink + extensions: + x-ms-pageable: + itemName: values + nextLinkName: nextLink + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMultiplePagesFailureUri + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_2 + isNullable: true + returnType: + body: *ref_2 + isNullable: true + serializedName: Paging_getMultiplePagesFailureUri + url: /paging/multiple/failureuri + - defaultResponse: + isNullable: true + deprecated: false + description: 'A paging operation that doesn''t return a full URL, just a fragment' + extensions: + x-ms-pageable: + itemName: values + nextLinkName: odata.nextLink + operationName: Paging_nextFragment + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMultiplePagesFragmentNextLink + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the api version to use. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api_version + serializedName: api_version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the tenant to use. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tenant + serializedName: tenant + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_3 + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: Paging_getMultiplePagesFragmentNextLink + url: '/paging/multiple/fragment/{tenant}' + - defaultResponse: + isNullable: true + deprecated: false + description: >- + A paging operation that doesn't return a full URL, just a fragment + with parameters grouped + extensions: + x-ms-pageable: + itemName: values + nextLinkName: odata.nextLink + operationName: Paging_nextFragmentWithGrouping + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getMultiplePagesFragmentWithGroupingNextLink + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the api version to use. + extensions: + x-ms-parameter-grouping: + name: custom-parameter-group + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api_version + serializedName: api_version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the tenant to use. + extensions: + x-ms-parameter-grouping: + name: custom-parameter-group + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tenant + serializedName: tenant + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_3 + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: Paging_getMultiplePagesFragmentWithGroupingNextLink + url: '/paging/multiple/fragmentwithgrouping/{tenant}' + - defaultResponse: + isNullable: true + deprecated: false + description: 'A paging operation that doesn''t return a full URL, just a fragment' + extensions: + x-ms-pageable: + itemName: values + nextLinkName: odata.nextLink + operationName: Paging_nextFragment + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: nextFragment + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the api version to use. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api_version + serializedName: api_version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the tenant to use. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tenant + serializedName: tenant + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Next link for list operation. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + serializedName: nextLink + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_3 + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: Paging_nextFragment + url: '/paging/multiple/fragment/{tenant}/{nextLink}' + - defaultResponse: + isNullable: true + deprecated: false + description: 'A paging operation that doesn''t return a full URL, just a fragment' + extensions: + x-ms-pageable: + itemName: values + nextLinkName: odata.nextLink + operationName: Paging_nextFragmentWithGrouping + group: + fixed: false + raw: Paging + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: nextFragmentWithGrouping + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the api version to use. + extensions: + x-ms-parameter-grouping: + name: custom-parameter-group + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api_version + serializedName: api_version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sets the tenant to use. + extensions: + x-ms-parameter-grouping: + name: custom-parameter-group + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tenant + serializedName: tenant + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Next link for list operation. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + serializedName: nextLink + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_3 + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: Paging_nextFragmentWithGrouping + url: '/paging/multiple/fragmentwithgrouping/{tenant}/{nextLink}' + name: + fixed: false + raw: Paging + nameForProperty: Paging + typeName: + fixed: false diff --git a/test/Expected/parameter-flattening/code-model-v1-yaml.yaml b/test/Expected/parameter-flattening/code-model-v1-yaml.yaml new file mode 100644 index 0000000..0b9f4c1 --- /dev/null +++ b/test/Expected/parameter-flattening/code-model-v1-yaml.yaml @@ -0,0 +1,137 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +codeGenExtensions: + ft: '2' +documentation: Resource Flattening for AutoRest +modelTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AvailabilitySetUpdateParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A description about the set of tags. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + summary: A set of tags. + serializedName: AvailabilitySetUpdateParameters +modelsName: Models +name: AutoRestParameterFlattening +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the tags for an availability set. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: AvailabilitySets + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: Update + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + constraints: + MaxLength: '80' + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the storage availability set. + extensions: + x-ms-client-name: avset + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: availabilitySetName + serializedName: availabilitySetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The tags. + extensions: + x-ms-requestBody-name: tags + isConstant: false + isRequired: true + location: body + modelType: *ref_0 + name: + fixed: false + raw: tags + serializedName: tags + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: AvailabilitySets_Update + url: '/parameterFlattening/{resourceGroupName}/{availabilitySetName}' + name: + fixed: false + raw: AvailabilitySets + nameForProperty: AvailabilitySets + typeName: + fixed: false diff --git a/test/Expected/report/code-model-v1-yaml.yaml b/test/Expected/report/code-model-v1-yaml.yaml new file mode 100644 index 0000000..caba584 --- /dev/null +++ b/test/Expected/report/code-model-v1-yaml.yaml @@ -0,0 +1,103 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestReportService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get test coverage report + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getReport + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_1 + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: getReport + url: /report + name: + fixed: false + raw: '' + nameForProperty: AutoRestReportService + typeName: + fixed: false diff --git a/test/Expected/required-optional/code-model-v1-yaml.yaml b/test/Expected/required-optional/code-model-v1-yaml.yaml new file mode 100644 index 0000000..33da6d3 --- /dev/null +++ b/test/Expected/required-optional/code-model-v1-yaml.yaml @@ -0,0 +1,1715 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: int-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: int-wrapper + - &ref_3 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: int-optional-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: int-optional-wrapper + - &ref_4 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: string-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: string-wrapper + - &ref_5 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: string-optional-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: string-optional-wrapper + - &ref_8 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: array-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: array-wrapper + - &ref_9 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: array-optional-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: array-optional-wrapper + - &ref_1 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: product + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: product + - &ref_6 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: class-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_1 + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: class-wrapper + - &ref_7 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: class-optional-wrapper + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: class-optional-wrapper +modelsName: Models +name: AutoRestRequiredOptionalTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test implicitly required path parameter + group: + fixed: false + raw: implicit + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getRequiredPath + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathParameter + serializedName: pathParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: implicit_getRequiredPath + url: '/reqopt/implicit/required/path/{pathParameter}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test implicitly optional query parameter + group: + fixed: false + raw: implicit + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putOptionalQuery + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: queryParameter + serializedName: queryParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: implicit_putOptionalQuery + url: /reqopt/implicit/optional/query + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test implicitly optional header parameter + group: + fixed: false + raw: implicit + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putOptionalHeader + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: queryParameter + serializedName: queryParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: implicit_putOptionalHeader + url: /reqopt/implicit/optional/header + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test implicitly optional body parameter + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: implicit + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: putOptionalBody + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: implicit_putOptionalBody + url: /reqopt/implicit/optional/body + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test implicitly required path parameter + group: + fixed: false + raw: implicit + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getRequiredGlobalPath + parameters: + - clientProperty: &ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: number of items to skip + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: required-global-path + realPath: + - required-global-path + serializedName: required-global-path + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: number of items to skip + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: required-global-path + serializedName: required-global-path + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: implicit_getRequiredGlobalPath + url: '/reqopt/global/required/path/{required-global-path}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test implicitly required query parameter + group: + fixed: false + raw: implicit + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getRequiredGlobalQuery + parameters: + - clientProperty: &ref_11 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: number of items to skip + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: required-global-query + realPath: + - required-global-query + serializedName: required-global-query + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: number of items to skip + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: required-global-query + serializedName: required-global-query + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: implicit_getRequiredGlobalQuery + url: /reqopt/global/required/query + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test implicitly optional query parameter + group: + fixed: false + raw: implicit + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getOptionalGlobalQuery + parameters: + - clientProperty: &ref_12 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: number of items to skip + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: optional-global-query + realPath: + - optional-global-query + serializedName: optional-global-query + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: number of items to skip + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: optional-global-query + serializedName: optional-global-query + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: implicit_getOptionalGlobalQuery + url: /reqopt/global/optional/query + name: + fixed: false + raw: Implicit + nameForProperty: Implicit + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required integer. Please put null and the client + library should throw before the request is sent. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredIntegerParameter + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredIntegerParameter + url: /reqopt/requied/integer/parameter + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test explicitly optional integer. Please put null. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalIntegerParameter + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalIntegerParameter + url: /reqopt/optional/integer/parameter + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required integer. Please put a valid int-wrapper with + 'value' = null and the client library should throw before the request + is sent. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredIntegerProperty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_2 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredIntegerProperty + url: /reqopt/requied/integer/property + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly optional integer. Please put a valid int-wrapper with + 'value' = null. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalIntegerProperty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: false + location: body + modelType: *ref_3 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalIntegerProperty + url: /reqopt/optional/integer/property + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required integer. Please put a header + 'headerParameter' => null and the client library should throw before + the request is sent. + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredIntegerHeader + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: headerParameter + serializedName: headerParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredIntegerHeader + url: /reqopt/requied/integer/header + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly optional integer. Please put a header + 'headerParameter' => null. + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalIntegerHeader + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: headerParameter + serializedName: headerParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalIntegerHeader + url: /reqopt/optional/integer/header + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required string. Please put null and the client + library should throw before the request is sent. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredStringParameter + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredStringParameter + url: /reqopt/requied/string/parameter + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test explicitly optional string. Please put null. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalStringParameter + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalStringParameter + url: /reqopt/optional/string/parameter + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required string. Please put a valid string-wrapper + with 'value' = null and the client library should throw before the + request is sent. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredStringProperty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_4 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredStringProperty + url: /reqopt/requied/string/property + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly optional integer. Please put a valid string-wrapper + with 'value' = null. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalStringProperty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: false + location: body + modelType: *ref_5 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalStringProperty + url: /reqopt/optional/string/property + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required string. Please put a header 'headerParameter' + => null and the client library should throw before the request is + sent. + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredStringHeader + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: headerParameter + serializedName: headerParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredStringHeader + url: /reqopt/requied/string/header + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly optional string. Please put a header 'headerParameter' + => null. + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalStringHeader + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalStringHeader + url: /reqopt/optional/string/header + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required complex object. Please put null and the + client library should throw before the request is sent. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredClassParameter + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_1 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredClassParameter + url: /reqopt/requied/class/parameter + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test explicitly optional complex object. Please put null. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalClassParameter + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: false + location: body + modelType: *ref_1 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalClassParameter + url: /reqopt/optional/class/parameter + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required complex object. Please put a valid + class-wrapper with 'value' = null and the client library should throw + before the request is sent. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredClassProperty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_6 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredClassProperty + url: /reqopt/requied/class/property + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly optional complex object. Please put a valid + class-wrapper with 'value' = null. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalClassProperty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: false + location: body + modelType: *ref_7 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalClassProperty + url: /reqopt/optional/class/property + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required array. Please put null and the client library + should throw before the request is sent. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredArrayParameter + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredArrayParameter + url: /reqopt/requied/array/parameter + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Test explicitly optional array. Please put null. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalArrayParameter + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: false + location: body + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalArrayParameter + url: /reqopt/optional/array/parameter + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required array. Please put a valid array-wrapper with + 'value' = null and the client library should throw before the request + is sent. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredArrayProperty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_8 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredArrayProperty + url: /reqopt/requied/array/property + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly optional array. Please put a valid array-wrapper with + 'value' = null. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalArrayProperty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: bodyParameter + isConstant: false + isRequired: false + location: body + modelType: *ref_9 + name: + fixed: false + raw: bodyParameter + serializedName: bodyParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalArrayProperty + url: /reqopt/optional/array/property + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly required array. Please put a header 'headerParameter' + => null and the client library should throw before the request is + sent. + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postRequiredArrayHeader + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: header + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: headerParameter + serializedName: headerParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + returnType: + body: *ref_0 + isNullable: true + serializedName: explicit_postRequiredArrayHeader + url: /reqopt/requied/array/header + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Test explicitly optional integer. Please put a header + 'headerParameter' => null. + group: + fixed: false + raw: explicit + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postOptionalArrayHeader + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: header + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: headerParameter + serializedName: headerParameter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: explicit_postOptionalArrayHeader + url: /reqopt/optional/array/header + name: + fixed: false + raw: Explicit + nameForProperty: Explicit + typeName: + fixed: false +properties: + - *ref_10 + - *ref_11 + - *ref_12 diff --git a/test/Expected/specs-batch/code-model-v1-yaml.yaml b/test/Expected/specs-batch/code-model-v1-yaml.yaml new file mode 100644 index 0000000..7a29657 --- /dev/null +++ b/test/Expected/specs-batch/code-model-v1-yaml.yaml @@ -0,0 +1,47531 @@ +--- +apiVersion: 2017-09-01.6.0 +baseUrl: 'https://batch.core.windows.net' +codeGenExtensions: + name: BatchServiceClient +documentation: A client for issuing REST requests to the Azure Batch service. +enumTypes: + - &ref_2 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: OSType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: linux + serializedName: linux + - name: windows + serializedName: windows + - &ref_3 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: AccessScope + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: job + serializedName: job + - &ref_8 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: CertificateState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: active + serializedName: active + - name: deleting + serializedName: deleting + - name: deleteFailed + serializedName: deleteFailed + - &ref_10 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: CertificateFormat + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: pfx + serializedName: pfx + - name: cer + serializedName: cer + - &ref_15 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: JobAction + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: none + serializedName: none + - name: disable + serializedName: disable + - name: terminate + serializedName: terminate + - &ref_16 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: DependencyAction + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: satisfy + serializedName: satisfy + - name: block + serializedName: block + - &ref_20 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: AutoUserScope + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: task + serializedName: task + - name: pool + serializedName: pool + - &ref_21 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ElevationLevel + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: nonAdmin + serializedName: nonAdmin + - name: admin + serializedName: admin + - &ref_25 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: OutputFileUploadCondition + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: taskSuccess + serializedName: taskSuccess + - name: taskFailure + serializedName: taskFailure + - name: taskCompletion + serializedName: taskCompletion + - &ref_36 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ComputeNodeFillType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: spread + serializedName: spread + - name: pack + serializedName: pack + - &ref_37 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: CertificateStoreLocation + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: currentUser + serializedName: currentUser + - name: localMachine + serializedName: localMachine + - &ref_38 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: CertificateVisibility + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: startTask + serializedName: startTask + - name: task + serializedName: task + - name: remoteUser + serializedName: remoteUser + - &ref_39 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: CachingType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: none + serializedName: none + - name: readOnly + serializedName: readOnly + - name: readWrite + serializedName: readWrite + - &ref_40 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: StorageAccountType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Standard_LRS + serializedName: Standard_LRS + - name: Premium_LRS + serializedName: Premium_LRS + - &ref_46 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: InboundEndpointProtocol + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: tcp + serializedName: tcp + - name: udp + serializedName: udp + - &ref_45 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: NetworkSecurityGroupRuleAccess + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: allow + serializedName: allow + - name: deny + serializedName: deny + - &ref_58 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: PoolLifetimeOption + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: jobSchedule + serializedName: jobSchedule + - name: job + serializedName: job + - &ref_61 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: OnAllTasksComplete + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: noAction + serializedName: noAction + - name: terminateJob + serializedName: terminateJob + - &ref_62 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: OnTaskFailure + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: noAction + serializedName: noAction + - name: performExitOptionsJobAction + serializedName: performExitOptionsJobAction + - &ref_69 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: JobScheduleState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: active + serializedName: active + - name: completed + serializedName: completed + - name: disabled + serializedName: disabled + - name: terminating + serializedName: terminating + - name: deleting + serializedName: deleting + - &ref_75 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ErrorCategory + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: userError + serializedName: userError + - name: serverError + serializedName: serverError + - &ref_77 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: JobState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: active + serializedName: active + - name: disabling + serializedName: disabling + - name: disabled + serializedName: disabled + - name: enabling + serializedName: enabling + - name: terminating + serializedName: terminating + - name: completed + serializedName: completed + - name: deleting + serializedName: deleting + - &ref_81 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: JobPreparationTaskState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: running + serializedName: running + - name: completed + serializedName: completed + - &ref_84 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: TaskExecutionResult + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: success + serializedName: success + - name: failure + serializedName: failure + - &ref_85 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: JobReleaseTaskState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: running + serializedName: running + - name: completed + serializedName: completed + - &ref_89 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: TaskCountValidationStatus + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: validated + serializedName: validated + - name: unvalidated + serializedName: unvalidated + - &ref_91 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: PoolState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: active + serializedName: active + - name: deleting + serializedName: deleting + - name: upgrading + serializedName: upgrading + - &ref_92 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: AllocationState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: steady + serializedName: steady + - name: resizing + serializedName: resizing + - name: stopping + serializedName: stopping + - &ref_100 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: TaskState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: active + serializedName: active + - name: preparing + serializedName: preparing + - name: running + serializedName: running + - name: completed + serializedName: completed + - &ref_111 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: TaskAddStatus + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: success + serializedName: success + - name: clientError + serializedName: clientError + - name: serverError + serializedName: serverError + - &ref_113 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: SubtaskState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: preparing + serializedName: preparing + - name: running + serializedName: running + - name: completed + serializedName: completed + - &ref_116 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: StartTaskState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: running + serializedName: running + - name: completed + serializedName: completed + - &ref_118 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ComputeNodeState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: idle + serializedName: idle + - name: rebooting + serializedName: rebooting + - name: reimaging + serializedName: reimaging + - name: running + serializedName: running + - name: unusable + serializedName: unusable + - name: creating + serializedName: creating + - name: starting + serializedName: starting + - name: waitingForStartTask + serializedName: waitingForStartTask + - name: startTaskFailed + serializedName: startTaskFailed + - name: unknown + serializedName: unknown + - name: leavingPool + serializedName: leavingPool + - name: offline + serializedName: offline + - name: preempted + serializedName: preempted + - &ref_119 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: SchedulingState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: enabled + serializedName: enabled + - name: disabled + serializedName: disabled + - &ref_125 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: DisableJobOption + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: requeue + serializedName: requeue + - name: terminate + serializedName: terminate + - name: wait + serializedName: wait + - &ref_126 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ComputeNodeDeallocationOption + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: requeue + serializedName: requeue + - name: terminate + serializedName: terminate + - name: taskCompletion + serializedName: taskCompletion + - name: retainedData + serializedName: retainedData + - &ref_127 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ComputeNodeRebootOption + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: requeue + serializedName: requeue + - name: terminate + serializedName: terminate + - name: taskCompletion + serializedName: taskCompletion + - name: retainedData + serializedName: retainedData + - &ref_128 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ComputeNodeReimageOption + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: requeue + serializedName: requeue + - name: terminate + serializedName: terminate + - name: taskCompletion + serializedName: taskCompletion + - name: retainedData + serializedName: retainedData + - &ref_129 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: DisableComputeNodeSchedulingOption + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: requeue + serializedName: requeue + - name: terminate + serializedName: terminate + - name: taskCompletion + serializedName: taskCompletion +errorTypes: + - &ref_110 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: BatchError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + summary: >- + An identifier for the error. Codes are invariant and are intended to + be consumed programmatically. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: &ref_108 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ErrorMessage + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: lang + realPath: + - lang + serializedName: lang + summary: The language code of the error message + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The text of the message. + serializedName: ErrorMessage + summary: An error message received in an Azure Batch error response. + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + summary: >- + A message describing the error, intended to be suitable for display in + a user interface. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: &ref_109 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: BatchErrorDetail + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: key + realPath: + - key + serializedName: key + summary: An identifier specifying the meaning of the Value property. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The additional information included with the error response. + serializedName: BatchErrorDetail + summary: >- + An item of additional information included in an Azure Batch error + response. + name: + fixed: false + name: + fixed: false + raw: values + realPath: + - values + serializedName: values + summary: >- + A collection of key-value pairs containing additional details about + the error. + serializedName: BatchError + summary: An error response received from the Azure Batch service. +headerTypes: + - &ref_130 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for List operation. + name: + fixed: false + raw: Application-List-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Application-List-Headers + - &ref_132 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Get operation. + name: + fixed: false + raw: Application-Get-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Application-Get-Headers + - &ref_134 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for ListUsageMetrics operation. + name: + fixed: false + raw: Pool-ListUsageMetrics-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Pool-ListUsageMetrics-Headers + - &ref_160 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for ListNodeAgentSkus operation. + name: + fixed: false + raw: Account-ListNodeAgentSkus-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Account-ListNodeAgentSkus-Headers + - &ref_136 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for GetAllLifetimeStatistics operation. + name: + fixed: false + raw: Pool-GetAllLifetimeStatistics-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Pool-GetAllLifetimeStatistics-Headers + - &ref_162 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for GetAllLifetimeStatistics operation. + name: + fixed: false + raw: Job-GetAllLifetimeStatistics-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Job-GetAllLifetimeStatistics-Headers + - &ref_183 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Add operation. + name: + fixed: false + raw: Certificate-Add-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Certificate-Add-Headers + - &ref_185 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for List operation. + name: + fixed: false + raw: Certificate-List-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Certificate-List-Headers + - &ref_187 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CancelDeletion operation. + name: + fixed: false + raw: Certificate-CancelDeletion-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Certificate-CancelDeletion-Headers + - &ref_188 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Delete operation. + name: + fixed: false + raw: Certificate-Delete-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Certificate-Delete-Headers + - &ref_189 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Get operation. + name: + fixed: false + raw: Certificate-Get-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Certificate-Get-Headers + - &ref_190 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for DeleteFromTask operation. + name: + fixed: false + raw: File-DeleteFromTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + serializedName: File-DeleteFromTask-Headers + - &ref_191 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for GetFromTask operation. + name: + fixed: false + raw: File-GetFromTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file creation time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-creation-time + realPath: + - ocp-creation-time + serializedName: ocp-creation-time + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Whether the object represents a directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: ocp-batch-file-isdirectory + realPath: + - ocp-batch-file-isdirectory + serializedName: ocp-batch-file-isdirectory + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The URL of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-batch-file-url + realPath: + - ocp-batch-file-url + serializedName: ocp-batch-file-url + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file mode attribute in octal format. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-batch-file-mode + realPath: + - ocp-batch-file-mode + serializedName: ocp-batch-file-mode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The content type of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Content-Type + realPath: + - Content-Type + serializedName: Content-Type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The length of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: Content-Length + realPath: + - Content-Length + serializedName: Content-Length + serializedName: File-GetFromTask-Headers + - &ref_193 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for GetPropertiesFromTask operation. + name: + fixed: false + raw: File-GetPropertiesFromTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file creation time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-creation-time + realPath: + - ocp-creation-time + serializedName: ocp-creation-time + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Whether the object represents a directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: ocp-batch-file-isdirectory + realPath: + - ocp-batch-file-isdirectory + serializedName: ocp-batch-file-isdirectory + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The URL of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-batch-file-url + realPath: + - ocp-batch-file-url + serializedName: ocp-batch-file-url + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file mode attribute in octal format. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-batch-file-mode + realPath: + - ocp-batch-file-mode + serializedName: ocp-batch-file-mode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The content type of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Content-Type + realPath: + - Content-Type + serializedName: Content-Type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The length of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: Content-Length + realPath: + - Content-Length + serializedName: Content-Length + serializedName: File-GetPropertiesFromTask-Headers + - &ref_194 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for DeleteFromComputeNode operation. + name: + fixed: false + raw: File-DeleteFromComputeNode-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + serializedName: File-DeleteFromComputeNode-Headers + - &ref_195 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for GetFromComputeNode operation. + name: + fixed: false + raw: File-GetFromComputeNode-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file creation time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-creation-time + realPath: + - ocp-creation-time + serializedName: ocp-creation-time + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Whether the object represents a directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: ocp-batch-file-isdirectory + realPath: + - ocp-batch-file-isdirectory + serializedName: ocp-batch-file-isdirectory + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The URL of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-batch-file-url + realPath: + - ocp-batch-file-url + serializedName: ocp-batch-file-url + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file mode attribute in octal format. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-batch-file-mode + realPath: + - ocp-batch-file-mode + serializedName: ocp-batch-file-mode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The content type of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Content-Type + realPath: + - Content-Type + serializedName: Content-Type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The length of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: Content-Length + realPath: + - Content-Length + serializedName: Content-Length + serializedName: File-GetFromComputeNode-Headers + - &ref_197 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for GetPropertiesFromComputeNode operation. + name: + fixed: false + raw: File-GetPropertiesFromComputeNode-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file creation time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-creation-time + realPath: + - ocp-creation-time + serializedName: ocp-creation-time + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Whether the object represents a directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: ocp-batch-file-isdirectory + realPath: + - ocp-batch-file-isdirectory + serializedName: ocp-batch-file-isdirectory + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The URL of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-batch-file-url + realPath: + - ocp-batch-file-url + serializedName: ocp-batch-file-url + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file mode attribute in octal format. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-batch-file-mode + realPath: + - ocp-batch-file-mode + serializedName: ocp-batch-file-mode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The content type of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Content-Type + realPath: + - Content-Type + serializedName: Content-Type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The length of the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: Content-Length + realPath: + - Content-Length + serializedName: Content-Length + serializedName: File-GetPropertiesFromComputeNode-Headers + - &ref_198 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for ListFromTask operation. + name: + fixed: false + raw: File-ListFromTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: File-ListFromTask-Headers + - &ref_200 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for ListFromComputeNode operation. + name: + fixed: false + raw: File-ListFromComputeNode-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: File-ListFromComputeNode-Headers + - &ref_201 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Exists operation. + name: + fixed: false + raw: JobSchedule-Exists-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: JobSchedule-Exists-Headers + - &ref_202 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Delete operation. + name: + fixed: false + raw: JobSchedule-Delete-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + serializedName: JobSchedule-Delete-Headers + - &ref_203 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Get operation. + name: + fixed: false + raw: JobSchedule-Get-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: JobSchedule-Get-Headers + - &ref_204 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Patch operation. + name: + fixed: false + raw: JobSchedule-Patch-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: JobSchedule-Patch-Headers + - &ref_206 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Update operation. + name: + fixed: false + raw: JobSchedule-Update-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: JobSchedule-Update-Headers + - &ref_208 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Disable operation. + name: + fixed: false + raw: JobSchedule-Disable-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: JobSchedule-Disable-Headers + - &ref_209 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Enable operation. + name: + fixed: false + raw: JobSchedule-Enable-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: JobSchedule-Enable-Headers + - &ref_210 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Terminate operation. + name: + fixed: false + raw: JobSchedule-Terminate-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: JobSchedule-Terminate-Headers + - &ref_211 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Add operation. + name: + fixed: false + raw: JobSchedule-Add-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: JobSchedule-Add-Headers + - &ref_213 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for List operation. + name: + fixed: false + raw: JobSchedule-List-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: JobSchedule-List-Headers + - &ref_163 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Delete operation. + name: + fixed: false + raw: Job-Delete-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + serializedName: Job-Delete-Headers + - &ref_164 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Get operation. + name: + fixed: false + raw: Job-Get-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Job-Get-Headers + - &ref_165 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Patch operation. + name: + fixed: false + raw: Job-Patch-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Job-Patch-Headers + - &ref_167 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Update operation. + name: + fixed: false + raw: Job-Update-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Job-Update-Headers + - &ref_169 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Disable operation. + name: + fixed: false + raw: Job-Disable-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Job-Disable-Headers + - &ref_171 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Enable operation. + name: + fixed: false + raw: Job-Enable-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Job-Enable-Headers + - &ref_172 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Terminate operation. + name: + fixed: false + raw: Job-Terminate-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Job-Terminate-Headers + - &ref_174 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Add operation. + name: + fixed: false + raw: Job-Add-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Job-Add-Headers + - &ref_176 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for List operation. + name: + fixed: false + raw: Job-List-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Job-List-Headers + - &ref_178 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for ListFromJobSchedule operation. + name: + fixed: false + raw: Job-ListFromJobSchedule-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Job-ListFromJobSchedule-Headers + - &ref_179 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for ListPreparationAndReleaseTaskStatus operation. + name: + fixed: false + raw: Job-ListPreparationAndReleaseTaskStatus-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Job-ListPreparationAndReleaseTaskStatus-Headers + - &ref_181 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for GetTaskCounts operation. + name: + fixed: false + raw: Job-GetTaskCounts-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + serializedName: Job-GetTaskCounts-Headers + - &ref_137 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Add operation. + name: + fixed: false + raw: Pool-Add-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-Add-Headers + - &ref_139 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for List operation. + name: + fixed: false + raw: Pool-List-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Pool-List-Headers + - &ref_141 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Delete operation. + name: + fixed: false + raw: Pool-Delete-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + serializedName: Pool-Delete-Headers + - &ref_142 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Exists operation. + name: + fixed: false + raw: Pool-Exists-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Pool-Exists-Headers + - &ref_143 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Get operation. + name: + fixed: false + raw: Pool-Get-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Pool-Get-Headers + - &ref_144 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Patch operation. + name: + fixed: false + raw: Pool-Patch-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-Patch-Headers + - &ref_146 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for DisableAutoScale operation. + name: + fixed: false + raw: Pool-DisableAutoScale-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-DisableAutoScale-Headers + - &ref_147 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for EnableAutoScale operation. + name: + fixed: false + raw: Pool-EnableAutoScale-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-EnableAutoScale-Headers + - &ref_149 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for EvaluateAutoScale operation. + name: + fixed: false + raw: Pool-EvaluateAutoScale-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-EvaluateAutoScale-Headers + - &ref_151 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Resize operation. + name: + fixed: false + raw: Pool-Resize-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-Resize-Headers + - &ref_153 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for StopResize operation. + name: + fixed: false + raw: Pool-StopResize-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-StopResize-Headers + - &ref_154 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for UpdateProperties operation. + name: + fixed: false + raw: Pool-UpdateProperties-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-UpdateProperties-Headers + - &ref_156 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for UpgradeOS operation. + name: + fixed: false + raw: Pool-UpgradeOS-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-UpgradeOS-Headers + - &ref_158 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for RemoveNodes operation. + name: + fixed: false + raw: Pool-RemoveNodes-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Pool-RemoveNodes-Headers + - &ref_215 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Add operation. + name: + fixed: false + raw: Task-Add-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Task-Add-Headers + - &ref_216 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for List operation. + name: + fixed: false + raw: Task-List-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Task-List-Headers + - &ref_218 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for AddCollection operation. + name: + fixed: false + raw: Task-AddCollection-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + serializedName: Task-AddCollection-Headers + - &ref_221 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Delete operation. + name: + fixed: false + raw: Task-Delete-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + serializedName: Task-Delete-Headers + - &ref_222 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Get operation. + name: + fixed: false + raw: Task-Get-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Task-Get-Headers + - &ref_223 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Update operation. + name: + fixed: false + raw: Task-Update-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Task-Update-Headers + - &ref_225 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for ListSubtasks operation. + name: + fixed: false + raw: Task-ListSubtasks-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: Task-ListSubtasks-Headers + - &ref_227 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Terminate operation. + name: + fixed: false + raw: Task-Terminate-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Task-Terminate-Headers + - &ref_228 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Reactivate operation. + name: + fixed: false + raw: Task-Reactivate-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: Task-Reactivate-Headers + - &ref_229 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for AddUser operation. + name: + fixed: false + raw: ComputeNode-AddUser-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: ComputeNode-AddUser-Headers + - &ref_231 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for DeleteUser operation. + name: + fixed: false + raw: ComputeNode-DeleteUser-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + serializedName: ComputeNode-DeleteUser-Headers + - &ref_232 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for UpdateUser operation. + name: + fixed: false + raw: ComputeNode-UpdateUser-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: ComputeNode-UpdateUser-Headers + - &ref_234 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Get operation. + name: + fixed: false + raw: ComputeNode-Get-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: ComputeNode-Get-Headers + - &ref_235 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Reboot operation. + name: + fixed: false + raw: ComputeNode-Reboot-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: ComputeNode-Reboot-Headers + - &ref_237 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Reimage operation. + name: + fixed: false + raw: ComputeNode-Reimage-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: ComputeNode-Reimage-Headers + - &ref_239 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for DisableScheduling operation. + name: + fixed: false + raw: ComputeNode-DisableScheduling-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: ComputeNode-DisableScheduling-Headers + - &ref_241 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for EnableScheduling operation. + name: + fixed: false + raw: ComputeNode-EnableScheduling-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData ID of the resource to which the request applied. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: DataServiceId + realPath: + - DataServiceId + serializedName: DataServiceId + serializedName: ComputeNode-EnableScheduling-Headers + - &ref_242 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for GetRemoteLoginSettings operation. + name: + fixed: false + raw: ComputeNode-GetRemoteLoginSettings-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: ComputeNode-GetRemoteLoginSettings-Headers + - &ref_244 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for GetRemoteDesktop operation. + name: + fixed: false + raw: ComputeNode-GetRemoteDesktop-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: ComputeNode-GetRemoteDesktop-Headers + - &ref_246 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for List operation. + name: + fixed: false + raw: ComputeNode-List-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client-request-id provided by the client during the request. + This will be returned only if the return-client-request-id parameter + was set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + realPath: + - client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A unique identifier for the request that was made to the Batch + service. If a request is consistently failing and you have verified + that the request is properly formulated, you may use this value to + report the error to Microsoft. In your report, include the value of + this request ID, the approximate time that the request was made, the + Batch account against which the request was made, and the region + that account resides in. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: request-id + realPath: + - request-id + serializedName: request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ETag HTTP response header. This is an opaque string. You can use + it to detect whether the resource has changed between requests. In + particular, you can pass the ETag to one of the If-Modified-Since, + If-Unmodified-Since, If-Match or If-None-Match headers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ETag + realPath: + - ETag + serializedName: ETag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time at which the resource was last modified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: Last-Modified + realPath: + - Last-Modified + serializedName: Last-Modified + serializedName: ComputeNode-List-Headers +modelTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolUsageMetrics + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + realPath: + - poolId + serializedName: poolId + summary: The ID of the pool whose metrics are aggregated in this entry. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The start time of the aggregation interval covered by this entry. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + summary: The end time of the aggregation interval covered by this entry. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For information about available sizes of virtual machines for Cloud + Services pools (pools created with cloudServiceConfiguration), see + Sizes for Cloud Services + (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). + Batch supports all Cloud Services VM sizes except ExtraSmall, + STANDARD_A1_V2 and STANDARD_A2_V2. For information about available + VM sizes for pools using images from the Virtual Machines + Marketplace (pools created with virtualMachineConfiguration) see + Sizes for Virtual Machines (Linux) + (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) + or Sizes for Virtual Machines (Windows) + (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). + Batch supports all Azure VM sizes except STANDARD_A0 and those with + premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 + series). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmSize + realPath: + - vmSize + serializedName: vmSize + summary: >- + The size of virtual machines in the pool. All VMs in a pool are the + same size. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: totalCoreHours + realPath: + - totalCoreHours + serializedName: totalCoreHours + summary: >- + The total core hours used in the pool during this aggregation + interval. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: dataIngressGiB + realPath: + - dataIngressGiB + serializedName: dataIngressGiB + summary: >- + The cross data center network ingress to the pool during this + interval, in GiB. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: dataEgressGiB + realPath: + - dataEgressGiB + serializedName: dataEgressGiB + summary: >- + The cross data center network egress from the pool during this + interval, in GiB. + serializedName: PoolUsageMetrics + summary: Usage metrics for a pool across an aggregation interval. + - &ref_135 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolListUsageMetricsResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_0 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The pool usage metrics data. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: PoolListUsageMetricsResult + summary: The result of a listing the usage metrics for an account. + - &ref_1 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ImageReference + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'For example, Canonical or MicrosoftWindowsServer.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisher + realPath: + - publisher + serializedName: publisher + summary: The publisher of the Azure Virtual Machines Marketplace image. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'For example, UbuntuServer or WindowsServer.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: offer + realPath: + - offer + serializedName: offer + summary: The offer type of the Azure Virtual Machines Marketplace image. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'For example, 14.04.0-LTS or 2012-R2-Datacenter.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sku + realPath: + - sku + serializedName: sku + summary: The SKU of the Azure Virtual Machines Marketplace image. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A value of 'latest' can be specified to select the latest version of + an image. If omitted, the default is 'latest'. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: version + realPath: + - version + serializedName: version + summary: The version of the Azure Virtual Machines Marketplace image. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is mutually exclusive with other ImageReference + properties. The virtual machine image must be in the same region and + subscription as the Azure Batch account. For information about the + firewall settings for the Batch node agent to communicate with the + Batch service see + https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: virtualMachineImageId + realPath: + - virtualMachineImageId + serializedName: virtualMachineImageId + summary: >- + The ARM resource identifier of the virtual machine image. Computes + nodes of the pool will be created using this custom image. This is of + the form + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} + serializedName: ImageReference + summary: >- + A reference to an Azure Virtual Machines Marketplace image or a custom + Azure Virtual Machine image. To get the list of all Azure Marketplace + image references verified by Azure Batch, see the 'List node agent SKUs' + operation. + - &ref_4 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The Batch node agent is a program that runs on each node in the pool, and + provides the command-and-control interface between the node and the Batch + service. There are different implementations of the node agent, known as + SKUs, for different operating systems. + name: + fixed: false + raw: NodeAgentSku + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: The ID of the node agent SKU. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This collection is not exhaustive (the node agent may be compatible + with other images). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: verifiedImageReferences + realPath: + - verifiedImageReferences + serializedName: verifiedImageReferences + summary: >- + The list of Azure Marketplace images verified to be compatible with + this node agent SKU. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: OSType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: osType + realPath: + - osType + serializedName: osType + summary: >- + The type of operating system (e.g. Windows or Linux) compatible with + the node agent SKU. + serializedName: NodeAgentSku + summary: A node agent SKU supported by the Batch service. + - &ref_35 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AuthenticationTokenSettings + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The authentication token grants access to a limited set of Batch + service operations. Currently the only supported value for the + access property is 'job', which grants access to all operations + related to the job which contains the task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_3 + extensions: + x-ms-enum: + modelAsString: false + name: AccessScope + x-nullable: false + name: + fixed: false + name: + fixed: false + raw: access + realPath: + - access + serializedName: access + summary: The Batch resources to which the token grants access. + serializedName: AuthenticationTokenSettings + summary: >- + The settings for an authentication token that the task can use to perform + Batch service operations. + - &ref_161 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AccountListNodeAgentSkusResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_4 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of supported node agent SKUs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: AccountListNodeAgentSkusResult + summary: The result of listing the supported node agent SKUs. + - &ref_5 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: UsageStatistics + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The start time of the time range covered by the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastUpdateTime + realPath: + - lastUpdateTime + serializedName: lastUpdateTime + summary: >- + The time at which the statistics were last updated. All statistics are + limited to the range between startTime and lastUpdateTime. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: dedicatedCoreTime + realPath: + - dedicatedCoreTime + serializedName: dedicatedCoreTime + summary: >- + The aggregated wall-clock time of the dedicated compute node cores + being part of the pool. + serializedName: UsageStatistics + summary: Statistics related to pool usage information. + - &ref_6 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ResourceStatistics + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The start time of the time range covered by the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastUpdateTime + realPath: + - lastUpdateTime + serializedName: lastUpdateTime + summary: >- + The time at which the statistics were last updated. All statistics are + limited to the range between startTime and lastUpdateTime. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: avgCPUPercentage + realPath: + - avgCPUPercentage + serializedName: avgCPUPercentage + summary: >- + The average CPU usage across all nodes in the pool (percentage per + node). + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: avgMemoryGiB + realPath: + - avgMemoryGiB + serializedName: avgMemoryGiB + summary: The average memory usage in GiB across all nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: peakMemoryGiB + realPath: + - peakMemoryGiB + serializedName: peakMemoryGiB + summary: The peak memory usage in GiB across all nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: avgDiskGiB + realPath: + - avgDiskGiB + serializedName: avgDiskGiB + summary: The average used disk space in GiB across all nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: peakDiskGiB + realPath: + - peakDiskGiB + serializedName: peakDiskGiB + summary: The peak used disk space in GiB across all nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: diskReadIOps + realPath: + - diskReadIOps + serializedName: diskReadIOps + summary: The total number of disk read operations across all nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: diskWriteIOps + realPath: + - diskWriteIOps + serializedName: diskWriteIOps + summary: >- + The total number of disk write operations across all nodes in the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: diskReadGiB + realPath: + - diskReadGiB + serializedName: diskReadGiB + summary: >- + The total amount of data in GiB of disk reads across all nodes in the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: diskWriteGiB + realPath: + - diskWriteGiB + serializedName: diskWriteGiB + summary: >- + The total amount of data in GiB of disk writes across all nodes in the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: networkReadGiB + realPath: + - networkReadGiB + serializedName: networkReadGiB + summary: >- + The total amount of data in GiB of network reads across all nodes in + the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: networkWriteGiB + realPath: + - networkWriteGiB + serializedName: networkWriteGiB + summary: >- + The total amount of data in GiB of network writes across all nodes in + the pool. + serializedName: ResourceStatistics + summary: Statistics related to resource consumption by compute nodes in a pool. + - &ref_95 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolStatistics + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL for the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The start time of the time range covered by the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastUpdateTime + realPath: + - lastUpdateTime + serializedName: lastUpdateTime + summary: >- + The time at which the statistics were last updated. All statistics are + limited to the range between startTime and lastUpdateTime. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_5 + name: + fixed: false + raw: usageStats + realPath: + - usageStats + serializedName: usageStats + summary: >- + Statistics related to pool usage, such as the amount of core-time + used. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_6 + name: + fixed: false + raw: resourceStats + realPath: + - resourceStats + serializedName: resourceStats + summary: >- + Statistics related to resource consumption by compute nodes in the + pool. + serializedName: PoolStatistics + summary: >- + Contains utilization and resource usage statistics for the lifetime of a + pool. + - &ref_79 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobStatistics + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The start time of the time range covered by the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastUpdateTime + realPath: + - lastUpdateTime + serializedName: lastUpdateTime + summary: >- + The time at which the statistics were last updated. All statistics are + limited to the range between startTime and lastUpdateTime. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: userCPUTime + realPath: + - userCPUTime + serializedName: userCPUTime + summary: >- + The total user mode CPU time (summed across all cores and all compute + nodes) consumed by all tasks in the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: kernelCPUTime + realPath: + - kernelCPUTime + serializedName: kernelCPUTime + summary: >- + The total kernel mode CPU time (summed across all cores and all + compute nodes) consumed by all tasks in the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ' The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If a task was retried, this includes the wall clock time of all the task retries.' + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: wallClockTime + realPath: + - wallClockTime + serializedName: wallClockTime + summary: The total wall clock time of all tasks in the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: readIOps + realPath: + - readIOps + serializedName: readIOps + summary: The total number of disk read operations made by all tasks in the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: writeIOps + realPath: + - writeIOps + serializedName: writeIOps + summary: >- + The total number of disk write operations made by all tasks in the + job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: readIOGiB + realPath: + - readIOGiB + serializedName: readIOGiB + summary: >- + The total amount of data in GiB read from disk by all tasks in the + job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: writeIOGiB + realPath: + - writeIOGiB + serializedName: writeIOGiB + summary: >- + The total amount of data in GiB written to disk by all tasks in the + job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A task completes successfully if it returns exit code 0. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: numSucceededTasks + realPath: + - numSucceededTasks + serializedName: numSucceededTasks + summary: >- + The total number of tasks successfully completed in the job during the + given time range. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A task fails if it exhausts its maximum retry count without + returning exit code 0. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: numFailedTasks + realPath: + - numFailedTasks + serializedName: numFailedTasks + summary: >- + The total number of tasks in the job that failed during the given time + range. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: numTaskRetries + realPath: + - numTaskRetries + serializedName: numTaskRetries + summary: >- + The total number of retries on all the tasks in the job during the + given time range. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The wait time for a task is defined as the elapsed time between the + creation of the task and the start of task execution. (If the task + is retried due to failures, the wait time is the time to the most + recent task execution.) This value is only reported in the account + lifetime statistics; it is not included in the job statistics. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: waitTime + realPath: + - waitTime + serializedName: waitTime + summary: The total wait time of all tasks in the job. + serializedName: JobStatistics + summary: Resource usage statistics for a job. + - &ref_7 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NameValuePair + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + summary: The name in the name-value pair. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The value in the name-value pair. + serializedName: NameValuePair + summary: Represents a name-value pair. + - &ref_9 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: DeleteCertificateError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + summary: >- + An identifier for the certificate deletion error. Codes are invariant + and are intended to be consumed programmatically. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + summary: >- + A message describing the certificate deletion error, intended to be + suitable for display in a user interface. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This list includes details such as the active pools and nodes + referencing this certificate. However, if a large number of + resources reference the certificate, the list contains only about + the first hundred. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_7 + name: + fixed: false + name: + fixed: false + raw: values + realPath: + - values + serializedName: values + summary: >- + A list of additional error details related to the certificate deletion + error. + serializedName: DeleteCertificateError + summary: An error encountered by the Batch service when deleting a certificate. + - &ref_11 + $type: CompositeType + containsConstantProperties: false + documentation: >- + A certificate that can be installed on compute nodes and can be used to + authenticate operations on the machine. + name: + fixed: false + raw: Certificate + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprint + realPath: + - thumbprint + serializedName: thumbprint + summary: >- + The X.509 thumbprint of the certificate. This is a sequence of up to + 40 hex digits. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprintAlgorithm + realPath: + - thumbprintAlgorithm + serializedName: thumbprintAlgorithm + summary: The algorithm used to derive the thumbprint. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the certificate. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: CertificateState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_8 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The current state of the certificate. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: stateTransitionTime + realPath: + - stateTransitionTime + serializedName: stateTransitionTime + summary: The time at which the certificate entered its current state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is not set if the certificate is in its initial active + state. + extensions: + x-ms-enum: + modelAsString: false + name: CertificateState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_8 + name: + fixed: false + raw: previousState + realPath: + - previousState + serializedName: previousState + summary: The previous state of the certificate. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is not set if the certificate is in its initial Active + state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: previousStateTransitionTime + realPath: + - previousStateTransitionTime + serializedName: previousStateTransitionTime + summary: The time at which the certificate entered its previous state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publicData + realPath: + - publicData + serializedName: publicData + summary: The public part of the certificate as a base-64 encoded .cer file. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the certificate is in the DeleteFailed + state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_9 + name: + fixed: false + raw: deleteCertificateError + realPath: + - deleteCertificateError + serializedName: deleteCertificateError + summary: >- + The error that occurred on the last attempt to delete this + certificate. + serializedName: Certificate + - &ref_34 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ApplicationPackageReference + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: applicationId + realPath: + - applicationId + serializedName: applicationId + summary: The ID of the application to deploy. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If this is omitted on a pool, and no default version is specified + for this application, the request fails with the error code + InvalidApplicationPackageReferences and HTTP status code 409. If + this is omitted on a task, and no default version is specified for + this application, the task fails with a pre-processing error. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: version + realPath: + - version + serializedName: version + summary: >- + The version of the application to deploy. If omitted, the default + version is deployed. + serializedName: ApplicationPackageReference + summary: A reference to an application package to be deployed to compute nodes. + - &ref_96 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ApplicationSummary + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the application within the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name for the application. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: versions + realPath: + - versions + serializedName: versions + summary: The list of available versions of the application. + serializedName: ApplicationSummary + summary: Contains information about an application in an Azure Batch account. + - &ref_184 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CertificateAddParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprint + realPath: + - thumbprint + serializedName: thumbprint + summary: >- + The X.509 thumbprint of the certificate. This is a sequence of up to + 40 hex digits (it may include spaces but these are removed). + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprintAlgorithm + realPath: + - thumbprintAlgorithm + serializedName: thumbprintAlgorithm + summary: The algorithm used to derive the thumbprint. This must be sha1. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: data + realPath: + - data + serializedName: data + summary: >- + The base64-encoded contents of the certificate. The maximum size is + 10KB. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: CertificateFormat + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_10 + name: + fixed: false + raw: certificateFormat + realPath: + - certificateFormat + serializedName: certificateFormat + summary: The format of the certificate data. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is required if the certificate format is pfx. It should be + omitted if the certificate format is cer. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: password + realPath: + - password + serializedName: password + summary: The password to access the certificate's private key. + serializedName: CertificateAddParameter + summary: >- + A certificate that can be installed on compute nodes and can be used to + authenticate operations on the machine. + - &ref_186 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CertificateListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_11 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of certificates. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: CertificateListResult + summary: The result of listing the certificates in the account. + - &ref_12 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: FileProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The creation time is not returned for files on Linux compute nodes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: creationTime + realPath: + - creationTime + serializedName: creationTime + summary: The file creation time. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastModified + realPath: + - lastModified + serializedName: lastModified + summary: The time at which the file was last modified. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: contentLength + realPath: + - contentLength + serializedName: contentLength + summary: The length of the file. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: contentType + realPath: + - contentType + serializedName: contentType + summary: The content type of the file. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file mode is returned only for files on Linux compute nodes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: fileMode + realPath: + - fileMode + serializedName: fileMode + summary: The file mode attribute in octal format. + serializedName: FileProperties + summary: The properties of a file on a compute node. + - &ref_13 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NodeFile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + summary: The file path. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the file. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isDirectory + realPath: + - isDirectory + serializedName: isDirectory + summary: Whether the object represents a directory. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_12 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + summary: The file properties. + serializedName: NodeFile + summary: Information about a file or directory on a compute node. + - &ref_199 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NodeFileListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_13 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of files. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: NodeFileListResult + summary: >- + The result of listing the files on a compute node, or the files associated + with a task on a node. + - &ref_70 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Schedule + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If you do not specify a doNotRunUntil time, the schedule becomes + ready to create jobs immediately. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: doNotRunUntil + realPath: + - doNotRunUntil + serializedName: doNotRunUntil + summary: >- + The earliest time at which any job may be created under this job + schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If you do not specify a doNotRunAfter time, and you are creating a + recurring job schedule, the job schedule will remain active until + you explicitly terminate it. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: doNotRunAfter + realPath: + - doNotRunAfter + serializedName: doNotRunAfter + summary: >- + A time after which no job will be created under this job schedule. The + schedule will move to the completed state as soon as this deadline is + past and there is no active job under this job schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If a job is not created within the startWindow interval, then the + 'opportunity' is lost; no job will be created until the next + recurrence of the schedule. If the schedule is recurring, and the + startWindow is longer than the recurrence interval, then this is + equivalent to an infinite startWindow, because the job that is 'due' + in one recurrenceInterval is not carried forward into the next + recurrence interval. The default is infinite. The minimum value is 1 + minute. If you specify a lower value, the Batch service rejects the + schedule with an error; if you are calling the REST API directly, + the HTTP status code is 400 (Bad Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: startWindow + realPath: + - startWindow + serializedName: startWindow + summary: >- + The time interval, starting from the time at which the schedule + indicates a job should be created, within which a job must be created. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Because a job schedule can have at most one active job under it at + any given time, if it is time to create a new job under a job + schedule, but the previous job is still running, the Batch service + will not create the new job until the previous job finishes. If the + previous job does not finish within the startWindow period of the + new recurrenceInterval, then no new job will be scheduled for that + interval. For recurring jobs, you should normally specify a + jobManagerTask in the jobSpecification. If you do not use + jobManagerTask, you will need an external process to monitor when + jobs are created, add tasks to the jobs and terminate the jobs ready + for the next recurrence. The default is that the schedule does not + recur: one job is created, within the startWindow after the + doNotRunUntil time, and the schedule is complete as soon as that job + finishes. The minimum value is 1 minute. If you specify a lower + value, the Batch service rejects the schedule with an error; if you + are calling the REST API directly, the HTTP status code is 400 (Bad + Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: recurrenceInterval + realPath: + - recurrenceInterval + serializedName: recurrenceInterval + summary: >- + The time interval between the start times of two successive jobs under + the job schedule. A job schedule can have at most one active job under + it at any given time. + serializedName: Schedule + summary: The schedule according to which jobs will be created + - &ref_63 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobConstraints + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the job does not complete within the time limit, the Batch + service terminates it and any tasks that are still running. In this + case, the termination reason will be MaxWallClockTimeExpiry. If this + property is not specified, there is no time limit on how long the + job may run. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: maxWallClockTime + realPath: + - maxWallClockTime + serializedName: maxWallClockTime + summary: >- + The maximum elapsed time that the job may run, measured from the time + the job is created. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Note that this value specifically controls the number of retries. + The Batch service will try each task once, and may then retry up to + this limit. For example, if the maximum retry count is 3, Batch + tries a task up to 4 times (one initial try and 3 retries). If the + maximum retry count is 0, the Batch service does not retry tasks. If + the maximum retry count is -1, the Batch service retries tasks + without limit. The default value is 0 (no retries). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxTaskRetryCount + realPath: + - maxTaskRetryCount + serializedName: maxTaskRetryCount + summary: >- + The maximum number of times each task may be retried. The Batch + service retries a task if its exit code is nonzero. + serializedName: JobConstraints + summary: The execution constraints for a job. + - &ref_14 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ContainerRegistry + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If omitted, the default is "docker.io".' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: registryServer + realPath: + - registryServer + serializedName: registryServer + summary: The registry URL. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-name: userName + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: username + realPath: + - username + serializedName: username + summary: The user name to log into the registry server. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: password + realPath: + - password + serializedName: password + summary: The password to log into the registry server. + serializedName: ContainerRegistry + summary: A private container registry. + - &ref_28 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskContainerSettings + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + These additional options are supplied as arguments to the "docker + create" command, in addition to those controlled by the Batch + Service. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: containerRunOptions + realPath: + - containerRunOptions + serializedName: containerRunOptions + summary: Additional options to the container create command. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the full image reference, as would be specified to "docker + pull". If no tag is provided as part of the image name, the tag + ":latest" is used as a default. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: imageName + realPath: + - imageName + serializedName: imageName + summary: The image to use to create the container in which the task will run. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This setting can be omitted if was already provided at pool + creation. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_14 + name: + fixed: false + raw: registry + realPath: + - registry + serializedName: registry + summary: The private registry which contains the container image. + serializedName: TaskContainerSettings + summary: The container settings for a task. + - &ref_29 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ResourceFile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This URL must be readable using anonymous access; that is, the Batch + service does not present any credentials when downloading the blob. + There are two ways to get such a URL for a blob in Azure storage: + include a Shared Access Signature (SAS) granting read permissions on + the blob, or set the ACL for the blob or its container to allow + public access. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: blobSource + realPath: + - blobSource + serializedName: blobSource + summary: The URL of the file within Azure Blob Storage. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filePath + realPath: + - filePath + serializedName: filePath + summary: >- + The location on the compute node to which to download the file, + relative to the task's working directory. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property applies only to files being downloaded to Linux + compute nodes. It will be ignored if it is specified for a + resourceFile which will be downloaded to a Windows node. If this + property is not specified for a Linux node, then a default value of + 0770 is applied to the file. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: fileMode + realPath: + - fileMode + serializedName: fileMode + summary: The file permission mode attribute in octal format. + serializedName: ResourceFile + summary: A file to be downloaded from Azure blob storage to a compute node. + - &ref_31 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: EnvironmentSetting + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + summary: The name of the environment variable. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The value of the environment variable. + serializedName: EnvironmentSetting + summary: An environment variable to be set on a task process. + - &ref_17 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ExitOptions + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + none - Take no action. + disable - Disable the job. This is equivalent to calling the disable job API, with a disableTasks value of requeue. + terminate - Terminate the job. The terminateReason in the job's executionInfo is set to "TaskFailed". The default is none for exit code 0 and terminate for all other exit conditions. + + If the job's onTaskFailed property is noAction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). + extensions: + x-ms-enum: + modelAsString: false + name: JobAction + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_15 + name: + fixed: false + raw: jobAction + realPath: + - jobAction + serializedName: jobAction + summary: >- + An action to take on the job containing the task, if the task + completes with the given exit condition and the job's onTaskFailed + property is 'performExitOptionsJobAction'. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + satisfy - Satisfy the task's dependencies. + block - Block the task's dependencies. + + The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an erro and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). + extensions: + x-ms-enum: + modelAsString: false + name: DependencyAction + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_16 + name: + fixed: false + raw: dependencyAction + realPath: + - dependencyAction + serializedName: dependencyAction + summary: >- + An action that the Batch service performs on tasks that depend on this + task. + serializedName: ExitOptions + summary: Specifies how the Batch service responds to a particular exit condition. + - &ref_18 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ExitCodeMapping + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + summary: A process exit code. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_17 + name: + fixed: false + raw: exitOptions + realPath: + - exitOptions + serializedName: exitOptions + summary: >- + How the Batch service should respond if the task exits with this exit + code. + serializedName: ExitCodeMapping + summary: >- + How the Batch service should respond if a task exits with a particular + exit code. + - &ref_19 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ExitCodeRangeMapping + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: start + realPath: + - start + serializedName: start + summary: The first exit code in the range. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: end + realPath: + - end + serializedName: end + summary: The last exit code in the range. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_17 + name: + fixed: false + raw: exitOptions + realPath: + - exitOptions + serializedName: exitOptions + summary: >- + How the Batch service should respond if the task exits with an exit + code in the range start to end (inclusive). + serializedName: ExitCodeRangeMapping + summary: >- + A range of exit codes and how the Batch service should respond to exit + codes within that range. + - &ref_99 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ExitConditions + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_18 + name: + fixed: false + name: + fixed: false + raw: exitCodes + realPath: + - exitCodes + serializedName: exitCodes + summary: >- + A list of individual task exit codes and how the Batch service should + respond to them. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_19 + name: + fixed: false + name: + fixed: false + raw: exitCodeRanges + realPath: + - exitCodeRanges + serializedName: exitCodeRanges + summary: >- + A list of task exit code ranges and how the Batch service should + respond to them. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_17 + name: + fixed: false + raw: preProcessingError + realPath: + - preProcessingError + serializedName: preProcessingError + summary: >- + How the Batch service should respond if the task fails to start due to + an error. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the task exited with an exit code that was specified via + exitCodes or exitCodeRanges, and then encountered a file upload + error, then the action specified by the exit code takes precedence. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_17 + name: + fixed: false + raw: fileUploadError + realPath: + - fileUploadError + serializedName: fileUploadError + summary: How the Batch service should respond if a file upload error occurs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This value is used if the task exits with any nonzero exit code not + listed in the exitCodes or exitCodeRanges collection, with a + pre-processing error if the preProcessingError property is not + present, or with a file upload error if the fileUploadError property + is not present. If you want non-default behaviour on exit code 0, + you must list it explicitly using the exitCodes or exitCodeRanges + collection. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_17 + name: + fixed: false + raw: default + realPath: + - default + serializedName: default + summary: >- + How the Batch service should respond if the task fails with an exit + condition not covered by any of the other properties. + serializedName: ExitConditions + summary: Specifies how the Batch service should respond when the task completes. + - &ref_22 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AutoUserSpecification + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + pool - specifies that the task runs as the common auto user account which is created on every node in a pool. + task - specifies that the service should create a new user for the task. + The default value is task. + extensions: + x-ms-enum: + modelAsString: false + name: AutoUserScope + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_20 + name: + fixed: false + raw: scope + realPath: + - scope + serializedName: scope + summary: The scope for the auto user + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + nonAdmin - The auto user is a standard user without elevated access. + admin - The auto user is a user with elevated access and operates + with full Administrator permissions. The default value is nonAdmin. + extensions: + x-ms-enum: + modelAsString: false + name: ElevationLevel + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_21 + name: + fixed: false + raw: elevationLevel + realPath: + - elevationLevel + serializedName: elevationLevel + summary: The elevation level of the auto user. + serializedName: AutoUserSpecification + summary: >- + Specifies the parameters for the auto user that runs a task on the Batch + service. + - &ref_33 + $type: CompositeType + containsConstantProperties: false + documentation: 'Specify either the userName or autoUser property, but not both.' + name: + fixed: false + raw: UserIdentity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The userName and autoUser properties are mutually exclusive; you + must specify one but not both. + extensions: + x-ms-client-name: userName + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: username + realPath: + - username + serializedName: username + summary: The name of the user identity under which the task is run. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The userName and autoUser properties are mutually exclusive; you + must specify one but not both. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_22 + name: + fixed: false + raw: autoUser + realPath: + - autoUser + serializedName: autoUser + summary: The auto user under which the task is run. + serializedName: UserIdentity + summary: The definition of the user identity under which the task is run. + - &ref_23 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: LinuxUserConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The uid and gid properties must be specified together or not at all. + If not specified the underlying operating system picks the uid. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: uid + realPath: + - uid + serializedName: uid + summary: The user ID of the user account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The uid and gid properties must be specified together or not at all. + If not specified the underlying operating system picks the gid. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: gid + realPath: + - gid + serializedName: gid + summary: The group ID for the user account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The private key must not be password protected. The private key is + used to automatically configure asymmetric-key based authentication + for SSH between nodes in a Linux pool when the pool's + enableInterNodeCommunication property is true (it is ignored if + enableInterNodeCommunication is false). It does this by placing the + key pair into the user's .ssh directory. If not specified, + password-less SSH is not configured between nodes (no modification + of the user's .ssh directory is done). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sshPrivateKey + realPath: + - sshPrivateKey + serializedName: sshPrivateKey + summary: The SSH private key for the user account. + serializedName: LinuxUserConfiguration + summary: Properties used to create a user account on a Linux node. + - &ref_56 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: UserAccount + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + summary: The name of the user account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: password + realPath: + - password + serializedName: password + summary: The password for the user account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + nonAdmin - The auto user is a standard user without elevated access. + admin - The auto user is a user with elevated access and operates + with full Administrator permissions. The default value is nonAdmin. + extensions: + x-ms-enum: + modelAsString: false + name: ElevationLevel + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_21 + name: + fixed: false + raw: elevationLevel + realPath: + - elevationLevel + serializedName: elevationLevel + summary: The elevation level of the user account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is ignored if specified on a Windows pool. If not + specified, the user is created with the default options. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_23 + name: + fixed: false + raw: linuxUserConfiguration + realPath: + - linuxUserConfiguration + serializedName: linuxUserConfiguration + summary: The Linux-specific user configuration for the user account. + serializedName: UserAccount + summary: >- + Properties used to create a user used to execute tasks on an Azure Batch + node. + - &ref_32 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskConstraints + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If this is not specified, there is no time limit on how long the + task may run. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: maxWallClockTime + realPath: + - maxWallClockTime + serializedName: maxWallClockTime + summary: >- + The maximum elapsed time that the task may run, measured from the time + the task starts. If the task does not complete within the time limit, + the Batch service terminates it. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default is infinite, i.e. the task directory will be retained + until the compute node is removed or reimaged. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: retentionTime + realPath: + - retentionTime + serializedName: retentionTime + summary: >- + The minimum time to retain the task directory on the compute node + where it ran, from the time it completes execution. After this time, + the Batch service may delete the task directory and all its contents. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Note that this value specifically controls the number of retries. + The Batch service will try the task once, and may then retry up to + this limit. For example, if the maximum retry count is 3, Batch + tries the task up to 4 times (one initial try and 3 retries). If the + maximum retry count is 0, the Batch service does not retry the task. + If the maximum retry count is -1, the Batch service retries the task + without limit. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxTaskRetryCount + realPath: + - maxTaskRetryCount + serializedName: maxTaskRetryCount + summary: >- + The maximum number of times the task may be retried. The Batch service + retries a task if its exit code is nonzero. + serializedName: TaskConstraints + summary: Execution constraints to apply to a task. + - &ref_24 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OutputFileBlobContainerDestination + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If filePattern refers to a specific file (i.e. contains no + wildcards), then path is the name of the blob to which to upload + that file. If filePattern contains one or more wildcards (and + therefore may match multiple files), then path is the name of the + blob virtual directory (which is prepended to each blob name) to + which to upload the file(s). If omitted, file(s) are uploaded to the + root of the container with a blob name matching their file name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + realPath: + - path + serializedName: path + summary: >- + The destination blob or virtual directory within the Azure Storage + container. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The URL must include a Shared Access Signature (SAS) granting write + permissions to the container. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: containerUrl + realPath: + - containerUrl + serializedName: containerUrl + summary: >- + The URL of the container within Azure Blob Storage to which to upload + the file(s). + serializedName: OutputFileBlobContainerDestination + summary: >- + Specifies a file upload destination within an Azure blob storage + container. + - &ref_26 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OutputFileDestination + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_24 + name: + fixed: false + raw: container + realPath: + - container + serializedName: container + summary: A location in Azure blob storage to which files are uploaded. + serializedName: OutputFileDestination + summary: The destination to which a file should be uploaded. + - &ref_27 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OutputFileUploadOptions + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The default is taskCompletion. + extensions: + x-ms-enum: + modelAsString: false + name: OutputFileUploadCondition + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_25 + name: + fixed: false + raw: uploadCondition + realPath: + - uploadCondition + serializedName: uploadCondition + summary: >- + The conditions under which the task output file or set of files should + be uploaded. + serializedName: OutputFileUploadOptions + summary: >- + Details about an output file upload operation, including under what + conditions to perform the upload. + - &ref_30 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OutputFile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Both relative and absolute paths are supported. Relative paths are + relative to the task working directory. The following wildcards are + supported: * matches 0 or more characters (for example pattern abc* + would match abc or abcdef), ** matches any directory, ? matches any + single character, [abc] matches one character in the brackets, and + [a-c] matches one character in the range. Brackets can include a + negation to match any character not specified (for example [!abc] + matches any character but a, b, or c). If a file name starts with + "." it is ignored by default but may be matched by specifying it + explicitly (for example *.gif will not match .a.gif, but .*.gif + will). A simple example: **\*.txt matches any file that does not + start in '.' and ends with .txt in the task working directory or any + subdirectory. If the filename contains a wildcard character it can + be escaped using brackets (for example abc[*] would match a file + named abc*). Note that both \ and / are treated as directory + separators on Windows, but only / is on Linux. Environment variables + (%var% on Windows or $var on Linux) are expanded prior to the + pattern being applied. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filePattern + realPath: + - filePattern + serializedName: filePattern + summary: A pattern indicating which file(s) to upload. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_26 + name: + fixed: false + raw: destination + realPath: + - destination + serializedName: destination + summary: The destination for the output file(s). + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_27 + name: + fixed: false + raw: uploadOptions + realPath: + - uploadOptions + serializedName: uploadOptions + summary: >- + Additional options for the upload operation, including under what + conditions to perform the upload. + serializedName: OutputFile + summary: >- + A specification for uploading files from an Azure Batch node to another + location after the Batch service has finished executing the task process. + - &ref_64 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The Job Manager task is automatically started when the job is created. The + Batch service tries to schedule the Job Manager task before any other + tasks in the job. When shrinking a pool, the Batch service tries to + preserve compute nodes where Job Manager tasks are running for as long as + possible (that is, nodes running 'normal' tasks are removed before nodes + running Job Manager tasks). When a Job Manager task fails and needs to be + restarted, the system tries to schedule it at the highest priority. If + there are no idle nodes available, the system may terminate one of the + running tasks in the pool and return it to the queue in order to make room + for the Job Manager task to restart. Note that a Job Manager task in one + job does not have priority over tasks in other jobs. Across jobs, only job + level priorities are observed. For example, if a Job Manager in a priority + 0 job needs to be restarted, it will not displace tasks of a priority 1 + job. + name: + fixed: false + raw: JobManagerTask + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID can contain any combination of alphanumeric characters + including hyphens and underscores and cannot contain more than 64 + characters. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the Job Manager task within the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + It need not be unique and can contain any Unicode characters up to a + maximum length of 1024. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name of the Job Manager task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The command line does not run under a shell, and therefore cannot + take advantage of shell features such as environment variable + expansion. If you want to take advantage of such features, you + should invoke the shell in the command line, for example using "cmd + /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: commandLine + realPath: + - commandLine + serializedName: commandLine + summary: The command line of the Job Manager task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the pool that will run this task has containerConfiguration set, + this must be set as well. If the pool that will run this task + doesn't have containerConfiguration set, this must not be set. When + this is specified, all directories recursively below the + AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the + node) are mapped into the container, all task environment variables + are mapped into the container, and the task command line is executed + in the container. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_28 + name: + fixed: false + raw: containerSettings + realPath: + - containerSettings + serializedName: containerSettings + summary: The settings for the container under which the Job Manager task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Files listed under this element are located in the task's working + directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_29 + name: + fixed: false + name: + fixed: false + raw: resourceFiles + realPath: + - resourceFiles + serializedName: resourceFiles + summary: >- + A list of files that the Batch service will download to the compute + node before running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For multi-instance tasks, the files will only be uploaded from the + compute node on which the primary task is executed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_30 + name: + fixed: false + name: + fixed: false + raw: outputFiles + realPath: + - outputFiles + serializedName: outputFiles + summary: >- + A list of files that the Batch service will upload from the compute + node after running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: environmentSettings + realPath: + - environmentSettings + serializedName: environmentSettings + summary: A list of environment variable settings for the Job Manager task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_32 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + summary: Constraints that apply to the Job Manager task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true, when the Job Manager task completes, the Batch service + marks the job as complete. If any tasks are still running at this + time (other than Job Release), those tasks are terminated. If false, + the completion of the Job Manager task does not affect the job + status. In this case, you should either use the onAllTasksComplete + attribute to terminate the job, or have a client or user terminate + the job explicitly. An example of this is if the Job Manager creates + a set of tasks but then takes no further role in their execution. + The default value is true. If you are using the onAllTasksComplete + and onTaskFailure attributes to control job lifetime, and using the + Job Manager task only to create the tasks for the job (not to + monitor progress), then it is important to set killJobOnCompletion + to false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: killJobOnCompletion + realPath: + - killJobOnCompletion + serializedName: killJobOnCompletion + summary: >- + Whether completion of the Job Manager task signifies completion of the + entire job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the task runs as a non-administrative user unique to the + task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_33 + name: + fixed: false + raw: userIdentity + realPath: + - userIdentity + serializedName: userIdentity + summary: The user identity under which the Job Manager task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true, no other tasks will run on the same compute node for as + long as the Job Manager is running. If false, other tasks can run + simultaneously with the Job Manager on a compute node. The Job + Manager task counts normally against the node's concurrent task + limit, so this is only relevant if the node allows multiple + concurrent tasks. The default value is true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: runExclusive + realPath: + - runExclusive + serializedName: runExclusive + summary: >- + Whether the Job Manager task requires exclusive use of the compute + node where it runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Application packages are downloaded and deployed to a shared + directory, not the task working directory. Therefore, if a + referenced package is already on the compute node, and is up to + date, then it is not re-downloaded; the existing copy on the compute + node is used. If a referenced application package cannot be + installed, for example because the package has been deleted or + because download failed, the task fails. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_34 + name: + fixed: false + name: + fixed: false + raw: applicationPackageReferences + realPath: + - applicationPackageReferences + serializedName: applicationPackageReferences + summary: >- + A list of application packages that the Batch service will deploy to + the compute node before running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If this property is set, the Batch service provides the task with an + authentication token which can be used to authenticate Batch service + operations without requiring an account access key. The token is + provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. + The operations that the task can carry out using the token depend on + the settings. For example, a task can request job permissions in + order to add other tasks to the job, or check the status of the job + or of other tasks under the job. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_35 + name: + fixed: false + raw: authenticationTokenSettings + realPath: + - authenticationTokenSettings + serializedName: authenticationTokenSettings + summary: >- + The settings for an authentication token that the task can use to + perform Batch service operations. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The default value is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: allowLowPriorityNode + realPath: + - allowLowPriorityNode + serializedName: allowLowPriorityNode + summary: Whether the Job Manager task may run on a low-priority compute node. + serializedName: JobManagerTask + summary: Specifies details of a Job Manager task. + - &ref_65 + $type: CompositeType + containsConstantProperties: false + documentation: >- + You can use Job Preparation to prepare a compute node to run tasks for the + job. Activities commonly performed in Job Preparation include: Downloading + common resource files used by all the tasks in the job. The Job + Preparation task can download these common resource files to the shared + location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting + a local service on the compute node so that all tasks of that job can + communicate with it. If the Job Preparation task fails (that is, exhausts + its retry count before exiting with exit code 0), Batch will not run tasks + of this job on the compute node. The node remains ineligible to run tasks + of this job until it is reimaged. The node remains active and can be used + for other jobs. The Job Preparation task can run multiple times on the + same compute node. Therefore, you should write the Job Preparation task to + handle re-execution. If the compute node is rebooted, the Job Preparation + task is run again on the node before scheduling any other task of the job, + if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task + did not previously complete. If the compute node is reimaged, the Job + Preparation task is run again before scheduling any task of the job. + name: + fixed: false + raw: JobPreparationTask + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID can contain any combination of alphanumeric characters + including hyphens and underscores and cannot contain more than 64 + characters. If you do not specify this property, the Batch service + assigns a default value of 'jobpreparation'. No other task in the + job can have the same ID as the Job Preparation task. If you try to + submit a task with the same id, the Batch service rejects the + request with error code TaskIdSameAsJobPreparationTask; if you are + calling the REST API directly, the HTTP status code is 409 + (Conflict). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: >- + A string that uniquely identifies the Job Preparation task within the + job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The command line does not run under a shell, and therefore cannot + take advantage of shell features such as environment variable + expansion. If you want to take advantage of such features, you + should invoke the shell in the command line, for example using "cmd + /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: commandLine + realPath: + - commandLine + serializedName: commandLine + summary: The command line of the Job Preparation task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When this is specified, all directories recursively below the + AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the + node) are mapped into the container, all task environment variables + are mapped into the container, and the task command line is executed + in the container. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_28 + name: + fixed: false + raw: containerSettings + realPath: + - containerSettings + serializedName: containerSettings + summary: >- + The settings for the container under which the Job Preparation task + runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Files listed under this element are located in the task's working + directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_29 + name: + fixed: false + name: + fixed: false + raw: resourceFiles + realPath: + - resourceFiles + serializedName: resourceFiles + summary: >- + A list of files that the Batch service will download to the compute + node before running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: environmentSettings + realPath: + - environmentSettings + serializedName: environmentSettings + summary: A list of environment variable settings for the Job Preparation task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_32 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + summary: Constraints that apply to the Job Preparation task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true and the Job Preparation task fails on a compute node, the + Batch service retries the Job Preparation task up to its maximum + retry count (as specified in the constraints element). If the task + has still not completed successfully after all retries, then the + Batch service will not schedule tasks of the job to the compute + node. The compute node remains active and eligible to run tasks of + other jobs. If false, the Batch service will not wait for the Job + Preparation task to complete. In this case, other tasks of the job + can start executing on the compute node while the Job Preparation + task is still running; and even if the Job Preparation task fails, + new tasks will continue to be scheduled on the node. The default + value is true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: waitForSuccess + realPath: + - waitForSuccess + serializedName: waitForSuccess + summary: >- + Whether the Batch service should wait for the Job Preparation task to + complete successfully before scheduling any other tasks of the job on + the compute node. A Job Preparation task has completed successfully if + it exits with exit code 0. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the task runs as a non-administrative user unique to the + task on Windows nodes, or a a non-administrative user unique to the + pool on Linux nodes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_33 + name: + fixed: false + raw: userIdentity + realPath: + - userIdentity + serializedName: userIdentity + summary: The user identity under which the Job Preparation task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Job Preparation task is always rerun if a compute node is + reimaged, or if the Job Preparation task did not complete (e.g. + because the reboot occurred while the task was running). Therefore, + you should always write a Job Preparation task to be idempotent and + to behave correctly if run multiple times. The default value is + true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: rerunOnNodeRebootAfterSuccess + realPath: + - rerunOnNodeRebootAfterSuccess + serializedName: rerunOnNodeRebootAfterSuccess + summary: >- + Whether the Batch service should rerun the Job Preparation task after + a compute node reboots. + serializedName: JobPreparationTask + summary: >- + A Job Preparation task to run before any tasks of the job on any given + compute node. + - &ref_66 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The Job Release task runs when the job ends, because of one of the + following: The user calls the Terminate Job API, or the Delete Job API + while the job is still active, the job's maximum wall clock time + constraint is reached, and the job is still active, or the job's Job + Manager task completed, and the job is configured to terminate when the + Job Manager completes. The Job Release task runs on each compute node + where tasks of the job have run and the Job Preparation task ran and + completed. If you reimage a compute node after it has run the Job + Preparation task, and the job ends without any further tasks of the job + running on that compute node (and hence the Job Preparation task does not + re-run), then the Job Release task does not run on that node. If a compute + node reboots while the Job Release task is still running, the Job Release + task runs again when the compute node starts up. The job is not marked as + complete until all Job Release tasks have completed. The Job Release task + runs in the background. It does not occupy a scheduling slot; that is, it + does not count towards the maxTasksPerNode limit specified on the pool. + name: + fixed: false + raw: JobReleaseTask + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID can contain any combination of alphanumeric characters + including hyphens and underscores and cannot contain more than 64 + characters. If you do not specify this property, the Batch service + assigns a default value of 'jobrelease'. No other task in the job + can have the same ID as the Job Release task. If you try to submit a + task with the same id, the Batch service rejects the request with + error code TaskIdSameAsJobReleaseTask; if you are calling the REST + API directly, the HTTP status code is 409 (Conflict). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the Job Release task within the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The command line does not run under a shell, and therefore cannot + take advantage of shell features such as environment variable + expansion. If you want to take advantage of such features, you + should invoke the shell in the command line, for example using "cmd + /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: commandLine + realPath: + - commandLine + serializedName: commandLine + summary: The command line of the Job Release task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When this is specified, all directories recursively below the + AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the + node) are mapped into the container, all task environment variables + are mapped into the container, and the task command line is executed + in the container. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_28 + name: + fixed: false + raw: containerSettings + realPath: + - containerSettings + serializedName: containerSettings + summary: The settings for the container under which the Job Release task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Files listed under this element are located in the task's working + directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_29 + name: + fixed: false + name: + fixed: false + raw: resourceFiles + realPath: + - resourceFiles + serializedName: resourceFiles + summary: >- + A list of files that the Batch service will download to the compute + node before running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: environmentSettings + realPath: + - environmentSettings + serializedName: environmentSettings + summary: A list of environment variable settings for the Job Release task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: maxWallClockTime + realPath: + - maxWallClockTime + serializedName: maxWallClockTime + summary: >- + The maximum elapsed time that the Job Release task may run on a given + compute node, measured from the time the task starts. If the task does + not complete within the time limit, the Batch service terminates it. + The default value is 15 minutes. You may not specify a timeout longer + than 15 minutes. If you do, the Batch service rejects it with an + error; if you are calling the REST API directly, the HTTP status code + is 400 (Bad Request). + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default is infinite, i.e. the task directory will be retained + until the compute node is removed or reimaged. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: retentionTime + realPath: + - retentionTime + serializedName: retentionTime + summary: >- + The minimum time to retain the task directory for the Job Release task + on the compute node. After this time, the Batch service may delete the + task directory and all its contents. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the task runs as a non-administrative user unique to the + task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_33 + name: + fixed: false + raw: userIdentity + realPath: + - userIdentity + serializedName: userIdentity + summary: The user identity under which the Job Release task runs. + serializedName: JobReleaseTask + summary: >- + A Job Release task to run on job completion on any compute node where the + job has run. + - &ref_52 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskSchedulingPolicy + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: ComputeNodeFillType + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_36 + name: + fixed: false + raw: nodeFillType + realPath: + - nodeFillType + serializedName: nodeFillType + summary: |- + How tasks are distributed across compute nodes in a pool. Values are: + + pack - As many tasks as possible (maxTasksPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool. + spread - Tasks should be assigned evenly across all nodes in the pool. + serializedName: TaskSchedulingPolicy + summary: Specifies how tasks should be distributed across compute nodes. + - &ref_54 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: StartTask + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The command line does not run under a shell, and therefore cannot + take advantage of shell features such as environment variable + expansion. If you want to take advantage of such features, you + should invoke the shell in the command line, for example using "cmd + /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: commandLine + realPath: + - commandLine + serializedName: commandLine + summary: The command line of the start task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When this is specified, all directories recursively below the + AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the + node) are mapped into the container, all task environment variables + are mapped into the container, and the task command line is executed + in the container. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_28 + name: + fixed: false + raw: containerSettings + realPath: + - containerSettings + serializedName: containerSettings + summary: The settings for the container under which the start task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Files listed under this element are located in the task's working + directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_29 + name: + fixed: false + name: + fixed: false + raw: resourceFiles + realPath: + - resourceFiles + serializedName: resourceFiles + summary: >- + A list of files that the Batch service will download to the compute + node before running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: environmentSettings + realPath: + - environmentSettings + serializedName: environmentSettings + summary: A list of environment variable settings for the start task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the task runs as a non-administrative user unique to the + task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_33 + name: + fixed: false + raw: userIdentity + realPath: + - userIdentity + serializedName: userIdentity + summary: The user identity under which the start task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch service retries a task if its exit code is nonzero. Note + that this value specifically controls the number of retries. The + Batch service will try the task once, and may then retry up to this + limit. For example, if the maximum retry count is 3, Batch tries the + task up to 4 times (one initial try and 3 retries). If the maximum + retry count is 0, the Batch service does not retry the task. If the + maximum retry count is -1, the Batch service retries the task + without limit. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxTaskRetryCount + realPath: + - maxTaskRetryCount + serializedName: maxTaskRetryCount + summary: The maximum number of times the task may be retried. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true and the start task fails on a compute node, the Batch + service retries the start task up to its maximum retry count + (maxTaskRetryCount). If the task has still not completed + successfully after all retries, then the Batch service marks the + compute node unusable, and will not schedule tasks to it. This + condition can be detected via the node state and failure info + details. If false, the Batch service will not wait for the start + task to complete. In this case, other tasks can start executing on + the compute node while the start task is still running; and even if + the start task fails, new tasks will continue to be scheduled on the + node. The default is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: waitForSuccess + realPath: + - waitForSuccess + serializedName: waitForSuccess + summary: >- + Whether the Batch service should wait for the start task to complete + successfully (that is, to exit with exit code 0) before scheduling any + tasks on the compute node. + serializedName: StartTask + summary: >- + A task which is run when a compute node joins a pool in the Azure Batch + service, or when the compute node is rebooted or reimaged. + - &ref_55 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CertificateReference + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprint + realPath: + - thumbprint + serializedName: thumbprint + summary: The thumbprint of the certificate. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprintAlgorithm + realPath: + - thumbprintAlgorithm + serializedName: thumbprintAlgorithm + summary: >- + The algorithm with which the thumbprint is associated. This must be + sha1. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default value is currentUser. This property is applicable only + for pools configured with Windows nodes (that is, created with + cloudServiceConfiguration, or with virtualMachineConfiguration using + a Windows image reference). For Linux compute nodes, the + certificates are stored in a directory inside the task working + directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is + supplied to the task to query for this location. For certificates + with visibility of 'remoteUser', a 'certs' directory is created in + the user's home directory (e.g., /home/{user-name}/certs) and + certificates are placed in that directory. + extensions: + x-ms-enum: + modelAsString: false + name: CertificateStoreLocation + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_37 + name: + fixed: false + raw: storeLocation + realPath: + - storeLocation + serializedName: storeLocation + summary: >- + The location of the certificate store on the compute node into which + to install the certificate. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is applicable only for pools configured with Windows + nodes (that is, created with cloudServiceConfiguration, or with + virtualMachineConfiguration using a Windows image reference). Common + store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, + TrustedPublisher, AuthRoot, AddressBook, but any custom store name + can also be used. The default value is My. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: storeName + realPath: + - storeName + serializedName: storeName + summary: >- + The name of the certificate store on the compute node into which to + install the certificate. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + starttask - The user account under which the start task is run. + task - The accounts under which job tasks are run. + remoteuser - The accounts under which users remotely access the node. + + You can specify more than one visibility in this collection. The default is all accounts. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_38 + extensions: + x-ms-enum: + modelAsString: false + name: CertificateVisibility + x-nullable: false + name: + fixed: false + name: + fixed: false + raw: visibility + realPath: + - visibility + serializedName: visibility + summary: >- + Which user accounts on the compute node should have access to the + private data of the certificate. + serializedName: CertificateReference + summary: A reference to a certificate to be installed on compute nodes in a pool. + - &ref_57 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The Batch service does not assign any meaning to this metadata; it is + solely for the use of user code. + name: + fixed: false + raw: MetadataItem + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + summary: The name of the metadata item. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The value of the metadata item. + serializedName: MetadataItem + summary: A name-value pair associated with a Batch service resource. + - &ref_50 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CloudServiceConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Possible values are: 2 - OS Family 2, equivalent to Windows Server + 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - + OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, + equivalent to Windows Server 2016. For more information, see Azure + Guest OS Releases + (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: osFamily + realPath: + - osFamily + serializedName: osFamily + summary: >- + The Azure Guest OS family to be installed on the virtual machines in + the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default value is * which specifies the latest operating system + version for the specified OS family. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: targetOSVersion + realPath: + - targetOSVersion + serializedName: targetOSVersion + summary: >- + The Azure Guest OS version to be installed on the virtual machines in + the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This may differ from targetOSVersion if the pool state is Upgrading. + In this case some virtual machines may be on the targetOSVersion and + some may be on the currentOSVersion during the upgrade process. Once + all virtual machines have upgraded, currentOSVersion is updated to + be the same as targetOSVersion. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: currentOSVersion + realPath: + - currentOSVersion + serializedName: currentOSVersion + summary: >- + The Azure Guest OS Version currently installed on the virtual machines + in the pool. + serializedName: CloudServiceConfiguration + summary: >- + The configuration for nodes in a pool based on the Azure Cloud Services + platform. + - &ref_41 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: OSDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + none - The caching mode for the disk is not enabled. + readOnly - The caching mode for the disk is read only. + readWrite - The caching mode for the disk is read and write. + + The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. + extensions: + x-ms-enum: + modelAsString: false + name: CachingType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_39 + name: + fixed: false + raw: caching + realPath: + - caching + serializedName: caching + summary: The type of caching to enable for the OS disk. + serializedName: OSDisk + summary: Settings for the operating system disk of the virtual machine. + - &ref_42 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: WindowsConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If omitted, the default value is true.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableAutomaticUpdates + realPath: + - enableAutomaticUpdates + serializedName: enableAutomaticUpdates + summary: Whether automatic updates are enabled on the virtual machine. + serializedName: WindowsConfiguration + summary: Windows operating system settings to apply to the virtual machine. + - &ref_43 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: DataDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The lun is used to uniquely identify each data disk. If attaching + multiple disks, each should have a distinct lun. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: lun + realPath: + - lun + serializedName: lun + summary: The logical unit number. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + none - The caching mode for the disk is not enabled. + readOnly - The caching mode for the disk is read only. + readWrite - The caching mode for the disk is read and write. + + The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. + extensions: + x-ms-enum: + modelAsString: false + name: CachingType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_39 + name: + fixed: false + raw: caching + realPath: + - caching + serializedName: caching + summary: The type of caching to be enabled for the data disks. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: diskSizeGB + realPath: + - diskSizeGB + serializedName: diskSizeGB + summary: The initial disk size in gigabytes. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + If omitted, the default is "Standard_LRS". Values are: + + Standard_LRS - The data disk should use standard locally redundant storage. + Premium_LRS - The data disk should use premium locally redundant storage. + extensions: + x-ms-enum: + modelAsString: false + name: StorageAccountType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_40 + name: + fixed: false + raw: storageAccountType + realPath: + - storageAccountType + serializedName: storageAccountType + summary: The storage account type to be used for the data disk. + serializedName: DataDisk + summary: >- + Settings which will be used by the data disks associated to compute nodes + in the pool. + - &ref_44 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: ContainerConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + raw: docker + documentation: + fixed: false + raw: |- + Values are: + + docker - Docker will be used to launch the containers. + extensions: + x-ms-enum: + modelAsString: false + name: ContainerType + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + summary: The container technology to be used. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the full image reference, as would be specified to "docker + pull". An image will be sourced from the default Docker registry + unless the image is fully qualified with an alternative registry. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: containerImageNames + realPath: + - containerImageNames + serializedName: containerImageNames + summary: The collection of container image names. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If any images must be downloaded from a private registry which + requires credentials, then those credentials must be provided here. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_14 + name: + fixed: false + name: + fixed: false + raw: containerRegistries + realPath: + - containerRegistries + serializedName: containerRegistries + summary: Additional private registries from which containers can be pulled. + serializedName: ContainerConfiguration + summary: The configuration for container-enabled pools. + - &ref_51 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: VirtualMachineConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_1 + name: + fixed: false + raw: imageReference + realPath: + - imageReference + serializedName: imageReference + summary: >- + A reference to the Azure Virtual Machines Marketplace image or the + custom Virtual Machine image to use. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_41 + name: + fixed: false + raw: osDisk + realPath: + - osDisk + serializedName: osDisk + summary: Settings for the operating system disk of the Virtual Machine. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch node agent is a program that runs on each node in the + pool, and provides the command-and-control interface between the + node and the Batch service. There are different implementations of + the node agent, known as SKUs, for different operating systems. You + must specify a node agent SKU which matches the selected image + reference. To get the list of supported node agent SKUs along with + their list of verified image references, see the 'List supported + node agent SKUs' operation. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeAgentSKUId + realPath: + - nodeAgentSKUId + serializedName: nodeAgentSKUId + summary: >- + The SKU of the Batch node agent to be provisioned on compute nodes in + the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must not be specified if the imageReference or osDisk + property specifies a Linux OS image. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_42 + name: + fixed: false + raw: windowsConfiguration + realPath: + - windowsConfiguration + serializedName: windowsConfiguration + summary: Windows operating system settings on the virtual machine. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must be specified if the compute nodes in the pool + need to have empty data disks attached to them. This cannot be + updated. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_43 + name: + fixed: false + name: + fixed: false + raw: dataDisks + realPath: + - dataDisks + serializedName: dataDisks + summary: >- + The configuration for data disks attached to the comptue nodes in the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + This only applies to images that contain the Windows operating + system, and should only be used when you hold valid on-premises + licenses for the nodes which will be deployed. If omitted, no + on-premises licensing discount is applied. Values are: + + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: licenseType + realPath: + - licenseType + serializedName: licenseType + summary: >- + The type of on-premises license to be used when deploying the + operating system. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If specified, setup is performed on each node in the pool to allow + tasks to run in containers. All regular tasks and job manager tasks + run on this pool must specify the containerSettings property, and + all other tasks may specify it. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_44 + name: + fixed: false + raw: containerConfiguration + realPath: + - containerConfiguration + serializedName: containerConfiguration + summary: The container configuration for the pool. + serializedName: VirtualMachineConfiguration + summary: >- + The configuration for compute nodes in a pool based on the Azure Virtual + Machines infrastructure. + - &ref_47 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NetworkSecurityGroupRule + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Priorities within a pool must be unique and are evaluated in order + of priority. The lower the number the higher the priority. For + example, rules could be specified with order numbers of 150, 250, + and 350. The rule with the order number of 150 takes precedence over + the rule that has an order of 250. Allowed priorities are 150 to + 3500. If any reserved or duplicate values are provided the request + fails with HTTP status code 400. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: priority + realPath: + - priority + serializedName: priority + summary: The priority for this rule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: NetworkSecurityGroupRuleAccess + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_45 + name: + fixed: false + raw: access + realPath: + - access + serializedName: access + summary: >- + The action that should be taken for a specified IP address, subnet + range or tag. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Valid values are a single IP address (i.e. 10.10.10.10), IP subnet + (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If + any other values are provided the request fails with HTTP status + code 400. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sourceAddressPrefix + realPath: + - sourceAddressPrefix + serializedName: sourceAddressPrefix + summary: The source address prefix or tag to match for the rule. + serializedName: NetworkSecurityGroupRule + summary: A network security group rule to apply to an inbound endpoint. + - &ref_48 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: InboundNATPool + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name must be unique within a Batch pool, can contain letters, + numbers, underscores, periods, and hyphens. Names must start with a + letter or number, must end with a letter, number, or underscore, and + cannot exceed 77 characters. If any invalid values are provided the + request fails with HTTP status code 400. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + summary: The name of the endpoint. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: InboundEndpointProtocol + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_46 + name: + fixed: false + raw: protocol + realPath: + - protocol + serializedName: protocol + summary: The protocol of the endpoint. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This must be unique within a Batch pool. Acceptable values are + between 1 and 65535 except for 22, 3389, 29876 and 29877 as these + are reserved. If any reserved values are provided the request fails + with HTTP status code 400. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: backendPort + realPath: + - backendPort + serializedName: backendPort + summary: The port number on the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Acceptable values range between 1 and 65534 except ports from 50000 + to 55000 which are reserved. All ranges within a pool must be + distinct and cannot overlap. If any reserved or overlapping values + are provided the request fails with HTTP status code 400. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: frontendPortRangeStart + realPath: + - frontendPortRangeStart + serializedName: frontendPortRangeStart + summary: >- + The first port number in the range of external ports that will be used + to provide inbound access to the backendPort on individual compute + nodes. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Acceptable values range between 1 and 65534 except ports from 50000 + to 55000 which are reserved by the Batch service. All ranges within + a pool must be distinct and cannot overlap. If any reserved or + overlapping values are provided the request fails with HTTP status + code 400. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: frontendPortRangeEnd + realPath: + - frontendPortRangeEnd + serializedName: frontendPortRangeEnd + summary: >- + The last port number in the range of external ports that will be used + to provide inbound access to the backendPort on individual compute + nodes. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The maximum number of rules that can be specified across all the + endpoints on a Batch pool is 25. If no network security group rules + are specified, a default rule will be created to allow inbound + access to the specified backendPort. If the maximum number of + network security group rules is exceeded the request fails with HTTP + status code 400. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_47 + name: + fixed: false + name: + fixed: false + raw: networkSecurityGroupRules + realPath: + - networkSecurityGroupRules + serializedName: networkSecurityGroupRules + summary: >- + A list of network security group rules that will be applied to the + endpoint. + serializedName: InboundNATPool + summary: >- + A inbound NAT pool that can be used to address specific ports on compute + nodes in a Batch pool externally. + - &ref_49 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolEndpointConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The maximum number of inbound NAT pools per Batch pool is 5. If the + maximum number of inbound NAT pools is exceeded the request fails + with HTTP status code 400. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_48 + name: + fixed: false + name: + fixed: false + raw: inboundNATPools + realPath: + - inboundNATPools + serializedName: inboundNATPools + summary: >- + A list of inbound NAT pools that can be used to address specific ports + on an individual compute node externally. + serializedName: PoolEndpointConfiguration + summary: The endpoint configuration for a pool. + - &ref_53 + $type: CompositeType + containsConstantProperties: false + documentation: The network configuration for a pool. + name: + fixed: false + raw: NetworkConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The virtual network must be in the same region and subscription as + the Azure Batch account. The specified subnet should have enough + free IP addresses to accommodate the number of nodes in the pool. If + the subnet doesn't have enough free IP addresses, the pool will + partially allocate compute nodes, and a resize error will occur. The + 'MicrosoftAzureBatch' service principal must have the 'Classic + Virtual Machine Contributor' Role-Based Access Control (RBAC) role + for the specified VNet. The specified subnet must allow + communication from the Azure Batch service to be able to schedule + tasks on the compute nodes. This can be verified by checking if the + specified VNet has any associated Network Security Groups (NSG). If + communication to the compute nodes in the specified subnet is denied + by an NSG, then the Batch service will set the state of the compute + nodes to unusable. For pools created with + virtualMachineConfiguration only ARM virtual networks + ('Microsoft.Network/virtualNetworks') are supported, but for pools + created with cloudServiceConfiguration both ARM and classic virtual + networks are supported. If the specified VNet has any associated + Network Security Groups (NSG), then a few reserved system ports must + be enabled for inbound communication. For pools created with a + virtual machine configuration, enable ports 29876 and 29877, as well + as port 22 for Linux and port 3389 for Windows. For pools created + with a cloud service configuration, enable ports 10100, 20100, and + 30100. Also enable outbound connections to Azure Storage on port + 443. For more details see: + https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subnetId + realPath: + - subnetId + serializedName: subnetId + summary: >- + The ARM resource identifier of the virtual network subnet which the + compute nodes of the pool will join. This is of the form + /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Pool endpoint configuration is only supported on pools with the + virtualMachineConfiguration property. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_49 + name: + fixed: false + raw: endpointConfiguration + realPath: + - endpointConfiguration + serializedName: endpointConfiguration + summary: The configuration for endpoints on compute nodes in the Batch pool. + serializedName: NetworkConfiguration + - &ref_59 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: PoolSpecification + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The display name need not be unique and can contain any Unicode + characters up to a maximum length of 1024. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For information about available sizes of virtual machines for Cloud + Services pools (pools created with cloudServiceConfiguration), see + Sizes for Cloud Services + (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). + Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 + and A2V2. For information about available VM sizes for pools using + images from the Virtual Machines Marketplace (pools created with + virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) + (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) + or Sizes for Virtual Machines (Windows) + (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). + Batch supports all Azure VM sizes except STANDARD_A0 and those with + premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 + series). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmSize + realPath: + - vmSize + serializedName: vmSize + summary: >- + The size of the virtual machines in the pool. All virtual machines in + a pool are the same size. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must be specified if the pool needs to be created with + Azure PaaS VMs. This property and virtualMachineConfiguration are + mutually exclusive and one of the properties must be specified. If + neither is specified then the Batch service returns an error; if you + are calling the REST API directly, the HTTP status code is 400 (Bad + Request). This property cannot be specified if the Batch account was + created with its poolAllocationMode property set to + 'UserSubscription'. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_50 + name: + fixed: false + raw: cloudServiceConfiguration + realPath: + - cloudServiceConfiguration + serializedName: cloudServiceConfiguration + summary: The cloud service configuration for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must be specified if the pool needs to be created with + Azure IaaS VMs. This property and cloudServiceConfiguration are + mutually exclusive and one of the properties must be specified. If + neither is specified then the Batch service returns an error; if you + are calling the REST API directly, the HTTP status code is 400 (Bad + Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_51 + name: + fixed: false + raw: virtualMachineConfiguration + realPath: + - virtualMachineConfiguration + serializedName: virtualMachineConfiguration + summary: The virtual machine configuration for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default value is 1. The maximum value of this setting depends on + the size of the compute nodes in the pool (the vmSize setting). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxTasksPerNode + realPath: + - maxTasksPerNode + serializedName: maxTasksPerNode + summary: >- + The maximum number of tasks that can run concurrently on a single + compute node in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_52 + name: + fixed: false + raw: taskSchedulingPolicy + realPath: + - taskSchedulingPolicy + serializedName: taskSchedulingPolicy + summary: How tasks are distributed across compute nodes in a pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This timeout applies only to manual scaling; it has no effect when + enableAutoScale is set to true. The default value is 15 minutes. The + minimum value is 5 minutes. If you specify a value less than 5 + minutes, the Batch service rejects the request with an error; if you + are calling the REST API directly, the HTTP status code is 400 (Bad + Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: resizeTimeout + realPath: + - resizeTimeout + serializedName: resizeTimeout + summary: The timeout for allocation of compute nodes to the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must not be specified if enableAutoScale is set to + true. If enableAutoScale is set to false, then you must set either + targetDedicatedNodes, targetLowPriorityNodes, or both. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetDedicatedNodes + realPath: + - targetDedicatedNodes + serializedName: targetDedicatedNodes + summary: The desired number of dedicated compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must not be specified if enableAutoScale is set to + true. If enableAutoScale is set to false, then you must set either + targetDedicatedNodes, targetLowPriorityNodes, or both. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetLowPriorityNodes + realPath: + - targetLowPriorityNodes + serializedName: targetLowPriorityNodes + summary: The desired number of low-priority compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If false, at least one of targetDedicateNodes and + targetLowPriorityNodes must be specified. If true, the + autoScaleFormula element is required. The pool automatically resizes + according to the formula. The default value is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableAutoScale + realPath: + - enableAutoScale + serializedName: enableAutoScale + summary: Whether the pool size should automatically adjust over time. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must not be specified if enableAutoScale is set to + false. It is required if enableAutoScale is set to true. The formula + is checked for validity before the pool is created. If the formula + is not valid, the Batch service rejects the request with detailed + error information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: autoScaleFormula + realPath: + - autoScaleFormula + serializedName: autoScaleFormula + summary: The formula for the desired number of compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default value is 15 minutes. The minimum and maximum value are 5 + minutes and 168 hours respectively. If you specify a value less than + 5 minutes or greater than 168 hours, the Batch service rejects the + request with an invalid property value error; if you are calling the + REST API directly, the HTTP status code is 400 (Bad Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: autoScaleEvaluationInterval + realPath: + - autoScaleEvaluationInterval + serializedName: autoScaleEvaluationInterval + summary: >- + The time interval at which to automatically adjust the pool size + according to the autoscale formula. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Enabling inter-node communication limits the maximum size of the + pool due to deployment restrictions on the nodes of the pool. This + may result in the pool not reaching its desired size. The default + value is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableInterNodeCommunication + realPath: + - enableInterNodeCommunication + serializedName: enableInterNodeCommunication + summary: Whether the pool permits direct communication between nodes. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_53 + name: + fixed: false + raw: networkConfiguration + realPath: + - networkConfiguration + serializedName: networkConfiguration + summary: The network configuration for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_54 + name: + fixed: false + raw: startTask + realPath: + - startTask + serializedName: startTask + summary: >- + A task to run on each compute node as it joins the pool. The task runs + when the node is added to the pool or when the node is restarted. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For Windows compute nodes, the Batch service installs the + certificates to the specified certificate store and location. For + Linux compute nodes, the certificates are stored in a directory + inside the task working directory and an environment variable + AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this + location. For certificates with visibility of 'remoteUser', a + 'certs' directory is created in the user's home directory (e.g., + /home/{user-name}/certs) and certificates are placed in that + directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_55 + name: + fixed: false + name: + fixed: false + raw: certificateReferences + realPath: + - certificateReferences + serializedName: certificateReferences + summary: >- + A list of certificates to be installed on each compute node in the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_34 + name: + fixed: false + name: + fixed: false + raw: applicationPackageReferences + realPath: + - applicationPackageReferences + serializedName: applicationPackageReferences + summary: >- + The list of application packages to be installed on each compute node + in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The list of application licenses must be a subset of available Batch + service application licenses. If a license is requested which is not + supported, pool creation will fail. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: applicationLicenses + realPath: + - applicationLicenses + serializedName: applicationLicenses + summary: >- + The list of application licenses the Batch service will make available + on each compute node in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_56 + name: + fixed: false + name: + fixed: false + raw: userAccounts + realPath: + - userAccounts + serializedName: userAccounts + summary: The list of user accounts to be created on each node in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch service does not assign any meaning to metadata; it is + solely for the use of user code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the pool as metadata. + serializedName: PoolSpecification + summary: Specification for creating a new pool. + - &ref_60 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: AutoPoolSpecification + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch service assigns each auto pool a unique identifier on + creation. To distinguish between pools created for different + purposes, you can specify this element to add a prefix to the ID + that is assigned. The prefix can be up to 20 characters long. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: autoPoolIdPrefix + realPath: + - autoPoolIdPrefix + serializedName: autoPoolIdPrefix + summary: >- + A prefix to be added to the unique identifier when a pool is + automatically created. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When the pool lifetime is jobSchedule the pool exists for the + lifetime of the job schedule. The Batch Service creates the pool + when it creates the first job on the schedule. You may apply this + option only to job schedules, not to jobs. When the pool lifetime is + job the pool exists for the lifetime of the job to which it is + dedicated. The Batch service creates the pool when it creates the + job. If the 'job' option is applied to a job schedule, the Batch + service creates a new auto pool for every job created on the + schedule. + extensions: + x-ms-enum: + modelAsString: false + name: PoolLifetimeOption + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_58 + name: + fixed: false + raw: poolLifetimeOption + realPath: + - poolLifetimeOption + serializedName: poolLifetimeOption + summary: >- + The minimum lifetime of created auto pools, and how multiple jobs on a + schedule are assigned to pools. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If false, the Batch service deletes the pool once its lifetime (as + determined by the poolLifetimeOption setting) expires; that is, when + the job or job schedule completes. If true, the Batch service does + not delete the pool automatically. It is up to the user to delete + auto pools created with this option. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: keepAlive + realPath: + - keepAlive + serializedName: keepAlive + summary: Whether to keep an auto pool alive after its lifetime expires. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_59 + name: + fixed: false + raw: pool + realPath: + - pool + serializedName: pool + summary: The pool specification for the auto pool. + serializedName: AutoPoolSpecification + summary: >- + Specifies characteristics for a temporary 'auto pool'. The Batch service + will create this auto pool when the job is submitted. + - &ref_67 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: PoolInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + You must ensure that the pool referenced by this property exists. If + the pool does not exist at the time the Batch service tries to + schedule a job, no tasks for the job will run until you create a + pool with that id. Note that the Batch service will not reject the + job request; it will simply not run tasks until the pool exists. You + must specify either the pool ID or the auto pool specification, but + not both. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + realPath: + - poolId + serializedName: poolId + summary: >- + The ID of an existing pool. All the tasks of the job will run on the + specified pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If auto pool creation fails, the Batch service moves the job to a + completed state, and the pool creation error is set in the job's + scheduling error property. The Batch service manages the lifetime + (both creation and, unless keepAlive is specified, deletion) of the + auto pool. Any user actions that affect the lifetime of the auto + pool while the job is active will result in unexpected behavior. You + must specify either the pool ID or the auto pool specification, but + not both. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_60 + name: + fixed: false + raw: autoPoolSpecification + realPath: + - autoPoolSpecification + serializedName: autoPoolSpecification + summary: >- + Characteristics for a temporary 'auto pool'. The Batch service will + create this auto pool when the job is submitted. + serializedName: PoolInformation + summary: Specifies how a job should be assigned to a pool. + - &ref_71 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: JobSpecification + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Priority values can range from -1000 to 1000, with -1000 being the + lowest priority and 1000 being the highest priority. The default + value is 0. This priority is used as the default for all jobs under + the job schedule. You can update a job's priority after it has been + created using by using the update job API. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: priority + realPath: + - priority + serializedName: priority + summary: The priority of jobs created under this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name need not be unique and can contain any Unicode characters + up to a maximum length of 1024. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name for jobs created under this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: usesTaskDependencies + realPath: + - usesTaskDependencies + serializedName: usesTaskDependencies + summary: >- + Whether tasks in the job can define dependencies on each other. The + default is false. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Note that if a job contains no tasks, then all tasks are considered + complete. This option is therefore most commonly used with a Job + Manager task; if you want to use automatic job termination without a + Job Manager, you should initially set onAllTasksComplete to noAction + and update the job properties to set onAllTasksComplete to + terminateJob once you have finished adding tasks. The default is + noAction. + extensions: + x-ms-enum: + modelAsString: false + name: OnAllTasksComplete + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_61 + name: + fixed: false + raw: onAllTasksComplete + realPath: + - onAllTasksComplete + serializedName: onAllTasksComplete + summary: >- + The action the Batch service should take when all tasks in a job + created under this schedule are in the completed state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The default is noAction. + extensions: + x-ms-enum: + modelAsString: false + name: OnTaskFailure + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_62 + name: + fixed: false + raw: onTaskFailure + realPath: + - onTaskFailure + serializedName: onTaskFailure + summary: >- + The action the Batch service should take when any task fails in a job + created under this schedule. A task is considered to have failed if it + have failed if has a failureInfo. A failureInfo is set if the task + completes with a non-zero exit code after exhausting its retry count, + or if there was an error starting the task, for example due to a + resource file download error. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_63 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + summary: The execution constraints for jobs created under this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the job does not specify a Job Manager task, the user must + explicitly add tasks to the job using the Task API. If the job does + specify a Job Manager task, the Batch service creates the Job + Manager task when the job is created, and will try to schedule the + Job Manager task before scheduling other tasks in the job. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_64 + name: + fixed: false + raw: jobManagerTask + realPath: + - jobManagerTask + serializedName: jobManagerTask + summary: >- + The details of a Job Manager task to be launched when a job is started + under this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If a job has a Job Preparation task, the Batch service will run the + Job Preparation task on a compute node before starting any tasks of + that job on that compute node. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_65 + name: + fixed: false + raw: jobPreparationTask + realPath: + - jobPreparationTask + serializedName: jobPreparationTask + summary: The Job Preparation task for jobs created under this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The primary purpose of the Job Release task is to undo changes to + compute nodes made by the Job Preparation task. Example activities + include deleting local files, or shutting down services that were + started as part of job preparation. A Job Release task cannot be + specified without also specifying a Job Preparation task for the + job. The Batch service runs the Job Release task on the compute + nodes that have run the Job Preparation task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_66 + name: + fixed: false + raw: jobReleaseTask + realPath: + - jobReleaseTask + serializedName: jobReleaseTask + summary: The Job Release task for jobs created under this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Individual tasks can override an environment setting specified here + by specifying the same setting name with a different value. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: commonEnvironmentSettings + realPath: + - commonEnvironmentSettings + serializedName: commonEnvironmentSettings + summary: >- + A list of common environment variable settings. These environment + variables are set for all tasks in jobs created under this schedule + (including the Job Manager, Job Preparation and Job Release tasks). + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_67 + name: + fixed: false + raw: poolInfo + realPath: + - poolInfo + serializedName: poolInfo + summary: >- + The pool on which the Batch service runs the tasks of jobs created + under this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch service does not assign any meaning to metadata; it is + solely for the use of user code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: >- + A list of name-value pairs associated with each job created under this + schedule as metadata. + serializedName: JobSpecification + summary: Specifies details of the jobs to be created on a schedule. + - &ref_68 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: RecentJob + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: The ID of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the job. + serializedName: RecentJob + summary: Information about the most recent job to run under the job schedule. + - &ref_72 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobScheduleExecutionInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is meaningful only if the schedule is in the active + state when the time comes around. For example, if the schedule is + disabled, no job will be created at nextRunTime unless the job is + enabled before then. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: nextRunTime + realPath: + - nextRunTime + serializedName: nextRunTime + summary: The next time at which a job will be created under this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is present only if the at least one job has run under + the schedule. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_68 + name: + fixed: false + raw: recentJob + realPath: + - recentJob + serializedName: recentJob + summary: Information about the most recent job under the job schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the job schedule is in the completed + state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + summary: The time at which the schedule ended. + serializedName: JobScheduleExecutionInformation + summary: >- + Contains information about jobs that have been and will be run under a job + schedule. + - &ref_73 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobScheduleStatistics + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The start time of the time range covered by the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastUpdateTime + realPath: + - lastUpdateTime + serializedName: lastUpdateTime + summary: >- + The time at which the statistics were last updated. All statistics are + limited to the range between startTime and lastUpdateTime. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: userCPUTime + realPath: + - userCPUTime + serializedName: userCPUTime + summary: >- + The total user mode CPU time (summed across all cores and all compute + nodes) consumed by all tasks in all jobs created under the schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: kernelCPUTime + realPath: + - kernelCPUTime + serializedName: kernelCPUTime + summary: >- + The total kernel mode CPU time (summed across all cores and all + compute nodes) consumed by all tasks in all jobs created under the + schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The wall clock time is the elapsed time from when the task started + running on a compute node to when it finished (or to the last time + the statistics were updated, if the task had not finished by then). + If a task was retried, this includes the wall clock time of all the + task retries. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: wallClockTime + realPath: + - wallClockTime + serializedName: wallClockTime + summary: >- + The total wall clock time of all the tasks in all the jobs created + under the schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: readIOps + realPath: + - readIOps + serializedName: readIOps + summary: >- + The total number of disk read operations made by all tasks in all jobs + created under the schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: writeIOps + realPath: + - writeIOps + serializedName: writeIOps + summary: >- + The total number of disk write operations made by all tasks in all + jobs created under the schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: readIOGiB + realPath: + - readIOGiB + serializedName: readIOGiB + summary: >- + The total gibibytes read from disk by all tasks in all jobs created + under the schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: writeIOGiB + realPath: + - writeIOGiB + serializedName: writeIOGiB + summary: >- + The total gibibytes written to disk by all tasks in all jobs created + under the schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: numSucceededTasks + realPath: + - numSucceededTasks + serializedName: numSucceededTasks + summary: >- + The total number of tasks successfully completed during the given time + range in jobs created under the schedule. A task completes + successfully if it returns exit code 0. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: numFailedTasks + realPath: + - numFailedTasks + serializedName: numFailedTasks + summary: >- + The total number of tasks that failed during the given time range in + jobs created under the schedule. A task fails if it exhausts its + maximum retry count without returning exit code 0. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: numTaskRetries + realPath: + - numTaskRetries + serializedName: numTaskRetries + summary: >- + The total number of retries during the given time range on all tasks + in all jobs created under the schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This value is only reported in the account lifetime statistics; it + is not included in the job statistics. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: waitTime + realPath: + - waitTime + serializedName: waitTime + summary: >- + The total wait time of all tasks in all jobs created under the + schedule. The wait time for a task is defined as the elapsed time + between the creation of the task and the start of task execution. (If + the task is retried due to failures, the wait time is the time to the + most recent task execution.) + serializedName: JobScheduleStatistics + summary: Resource usage statistics for a job schedule. + - &ref_74 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: CloudJobSchedule + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the schedule within the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name for the schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the job schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is an opaque string. You can use it to detect whether the job + schedule has changed between requests. In particular, you can be + pass the ETag with an Update Job Schedule request to specify that + your changes should take effect only if nobody else has modified the + schedule in the meantime. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: eTag + realPath: + - eTag + serializedName: eTag + summary: The ETag of the job schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the last time at which the schedule level data, such as the + job specification or recurrence information, changed. It does not + factor in job-level changes such as new jobs being created or jobs + changing state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastModified + realPath: + - lastModified + serializedName: lastModified + summary: The last modified time of the job schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: creationTime + realPath: + - creationTime + serializedName: creationTime + summary: The creation time of the job schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: JobScheduleState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_69 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The current state of the job schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: stateTransitionTime + realPath: + - stateTransitionTime + serializedName: stateTransitionTime + summary: The time at which the job schedule entered the current state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is not present if the job schedule is in its initial + active state. + extensions: + x-ms-enum: + modelAsString: false + name: JobScheduleState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_69 + name: + fixed: false + raw: previousState + realPath: + - previousState + serializedName: previousState + summary: The previous state of the job schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is not present if the job schedule is in its initial + active state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: previousStateTransitionTime + realPath: + - previousStateTransitionTime + serializedName: previousStateTransitionTime + summary: The time at which the job schedule entered its previous state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_70 + name: + fixed: false + raw: schedule + realPath: + - schedule + serializedName: schedule + summary: The schedule according to which jobs will be created. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_71 + name: + fixed: false + raw: jobSpecification + realPath: + - jobSpecification + serializedName: jobSpecification + summary: The details of the jobs to be created on this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_72 + name: + fixed: false + raw: executionInfo + realPath: + - executionInfo + serializedName: executionInfo + summary: >- + Information about jobs that have been and will be run under this + schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch service does not assign any meaning to metadata; it is + solely for the use of user code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the schedule as metadata. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_73 + name: + fixed: false + raw: stats + realPath: + - stats + serializedName: stats + summary: The lifetime resource usage statistics for the job schedule. + serializedName: CloudJobSchedule + summary: >- + A job schedule that allows recurring jobs by specifying when to run jobs + and a specification used to create each job. + - &ref_212 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: JobScheduleAddParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID can contain any combination of alphanumeric characters + including hyphens and underscores, and cannot contain more than 64 + characters. The ID is case-preserving and case-insensitive (that is, + you may not have two IDs within an account that differ only by + case). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the schedule within the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The display name need not be unique and can contain any Unicode + characters up to a maximum length of 1024. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name for the schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_70 + name: + fixed: false + raw: schedule + realPath: + - schedule + serializedName: schedule + summary: The schedule according to which jobs will be created. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_71 + name: + fixed: false + raw: jobSpecification + realPath: + - jobSpecification + serializedName: jobSpecification + summary: The details of the jobs to be created on this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch service does not assign any meaning to metadata; it is + solely for the use of user code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the schedule as metadata. + serializedName: JobScheduleAddParameter + summary: >- + A job schedule that allows recurring jobs by specifying when to run jobs + and a specification used to create each job. + - &ref_214 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CloudJobScheduleListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_74 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of job schedules. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: CloudJobScheduleListResult + summary: The result of listing the job schedules in an account. + - &ref_76 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobSchedulingError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: ErrorCategory + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_75 + name: + fixed: false + raw: category + realPath: + - category + serializedName: category + summary: The category of the job scheduling error. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + summary: >- + An identifier for the job scheduling error. Codes are invariant and + are intended to be consumed programmatically. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + summary: >- + A message describing the job scheduling error, intended to be suitable + for display in a user interface. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_7 + name: + fixed: false + name: + fixed: false + raw: details + realPath: + - details + serializedName: details + summary: A list of additional error details related to the scheduling error. + serializedName: JobSchedulingError + summary: An error encountered by the Batch service when scheduling a job. + - &ref_78 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobExecutionInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This is the time at which the job was created. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The start time of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the job is in the completed state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + summary: The completion time of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This element contains the actual pool where the job is assigned. + When you get job details from the service, they also contain a + poolInfo element, which contains the pool configuration data from + when the job was added or updated. That poolInfo element may also + contain a poolId element. If it does, the two IDs are the same. If + it does not, it means the job ran on an auto pool, and this property + contains the ID of that auto pool. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + realPath: + - poolId + serializedName: poolId + summary: The ID of the pool to which this job is assigned. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is not set if there was no error starting the job. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_76 + name: + fixed: false + raw: schedulingError + realPath: + - schedulingError + serializedName: schedulingError + summary: Details of any error encountered by the service in starting the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the job is in the completed state. If + the Batch service terminates the job, it sets the reason as follows: + JMComplete - the Job Manager task completed, and killJobOnCompletion + was set to true. MaxWallClockTimeExpiry - the job reached its + maxWallClockTime constraint. TerminateJobSchedule - the job ran as + part of a schedule, and the schedule terminated. AllTasksComplete - + the job's onAllTasksComplete attribute is set to terminateJob, and + all tasks in the job are complete. TaskFailed - the job's + onTaskFailure attribute is set to performExitOptionsJobAction, and a + task in the job failed with an exit condition that specified a + jobAction of terminateJob. Any other string is a user-defined reason + specified in a call to the 'Terminate a job' operation. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: terminateReason + realPath: + - terminateReason + serializedName: terminateReason + summary: A string describing the reason the job ended. + serializedName: JobExecutionInformation + summary: >- + Contains information about the execution of a job in the Azure Batch + service. + - &ref_80 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: CloudJob + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID is case-preserving and case-insensitive (that is, you may not + have two IDs within an account that differ only by case). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the job within the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name for the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: usesTaskDependencies + realPath: + - usesTaskDependencies + serializedName: usesTaskDependencies + summary: >- + Whether tasks in the job can define dependencies on each other. The + default is false. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is an opaque string. You can use it to detect whether the job + has changed between requests. In particular, you can be pass the + ETag when updating a job to specify that your changes should take + effect only if nobody else has modified the job in the meantime. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: eTag + realPath: + - eTag + serializedName: eTag + summary: The ETag of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the last time at which the job level data, such as the job + state or priority, changed. It does not factor in task-level changes + such as adding new tasks or tasks changing state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastModified + realPath: + - lastModified + serializedName: lastModified + summary: The last modified time of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: creationTime + realPath: + - creationTime + serializedName: creationTime + summary: The creation time of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: JobState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_77 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The current state of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: stateTransitionTime + realPath: + - stateTransitionTime + serializedName: stateTransitionTime + summary: The time at which the job entered its current state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is not set if the job is in its initial Active state. + extensions: + x-ms-enum: + modelAsString: false + name: JobState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_77 + name: + fixed: false + raw: previousState + realPath: + - previousState + serializedName: previousState + summary: The previous state of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is not set if the job is in its initial Active state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: previousStateTransitionTime + realPath: + - previousStateTransitionTime + serializedName: previousStateTransitionTime + summary: The time at which the job entered its previous state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Priority values can range from -1000 to 1000, with -1000 being the + lowest priority and 1000 being the highest priority. The default + value is 0. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: priority + realPath: + - priority + serializedName: priority + summary: The priority of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_63 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + summary: The execution constraints for the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_64 + name: + fixed: false + raw: jobManagerTask + realPath: + - jobManagerTask + serializedName: jobManagerTask + summary: Details of a Job Manager task to be launched when the job is started. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Job Preparation task is a special task run on each node before + any other task of the job. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_65 + name: + fixed: false + raw: jobPreparationTask + realPath: + - jobPreparationTask + serializedName: jobPreparationTask + summary: The Job Preparation task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Job Release task is a special task run at the end of the job on + each node that has run any other task of the job. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_66 + name: + fixed: false + raw: jobReleaseTask + realPath: + - jobReleaseTask + serializedName: jobReleaseTask + summary: The Job Release task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Individual tasks can override an environment setting specified here + by specifying the same setting name with a different value. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: commonEnvironmentSettings + realPath: + - commonEnvironmentSettings + serializedName: commonEnvironmentSettings + summary: >- + The list of common environment variable settings. These environment + variables are set for all tasks in the job (including the Job Manager, + Job Preparation and Job Release tasks). + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_67 + name: + fixed: false + raw: poolInfo + realPath: + - poolInfo + serializedName: poolInfo + summary: The pool settings associated with the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + noAction - do nothing. The job remains active unless terminated or + disabled by some other means. terminateJob - terminate the job. The + job's terminateReason is set to 'AllTasksComplete'. The default is + noAction. + extensions: + x-ms-enum: + modelAsString: false + name: OnAllTasksComplete + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_61 + name: + fixed: false + raw: onAllTasksComplete + realPath: + - onAllTasksComplete + serializedName: onAllTasksComplete + summary: >- + The action the Batch service should take when all tasks in the job are + in the completed state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A task is considered to have failed if has a failureInfo. A + failureInfo is set if the task completes with a non-zero exit code + after exhausting its retry count, or if there was an error starting + the task, for example due to a resource file download error. + noAction - do nothing. performExitOptionsJobAction - take the action + associated with the task exit condition in the task's exitConditions + collection. (This may still result in no action being taken, if that + is what the task specifies.) The default is noAction. + extensions: + x-ms-enum: + modelAsString: false + name: OnTaskFailure + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_62 + name: + fixed: false + raw: onTaskFailure + realPath: + - onTaskFailure + serializedName: onTaskFailure + summary: >- + The action the Batch service should take when any task in the job + fails. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch service does not assign any meaning to metadata; it is + solely for the use of user code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the job as metadata. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_78 + name: + fixed: false + raw: executionInfo + realPath: + - executionInfo + serializedName: executionInfo + summary: The execution information for the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_79 + name: + fixed: false + raw: stats + realPath: + - stats + serializedName: stats + summary: Resource usage statistics for the entire lifetime of the job. + serializedName: CloudJob + summary: An Azure Batch job. + - &ref_175 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: JobAddParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID can contain any combination of alphanumeric characters + including hyphens and underscores, and cannot contain more than 64 + characters. The ID is case-preserving and case-insensitive (that is, + you may not have two IDs within an account that differ only by + case). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the job within the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The display name need not be unique and can contain any Unicode + characters up to a maximum length of 1024. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name for the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Priority values can range from -1000 to 1000, with -1000 being the + lowest priority and 1000 being the highest priority. The default + value is 0. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: priority + realPath: + - priority + serializedName: priority + summary: The priority of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The execution constraints for the job. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_63 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the job does not specify a Job Manager task, the user must + explicitly add tasks to the job. If the job does specify a Job + Manager task, the Batch service creates the Job Manager task when + the job is created, and will try to schedule the Job Manager task + before scheduling other tasks in the job. The Job Manager task's + typical purpose is to control and/or monitor job execution, for + example by deciding what additional tasks to run, determining when + the work is complete, etc. (However, a Job Manager task is not + restricted to these activities - it is a fully-fledged task in the + system and perform whatever actions are required for the job.) For + example, a Job Manager task might download a file specified as a + parameter, analyze the contents of that file and submit additional + tasks based on those contents. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_64 + name: + fixed: false + raw: jobManagerTask + realPath: + - jobManagerTask + serializedName: jobManagerTask + summary: Details of a Job Manager task to be launched when the job is started. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If a job has a Job Preparation task, the Batch service will run the + Job Preparation task on a compute node before starting any tasks of + that job on that compute node. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_65 + name: + fixed: false + raw: jobPreparationTask + realPath: + - jobPreparationTask + serializedName: jobPreparationTask + summary: The Job Preparation task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A Job Release task cannot be specified without also specifying a Job + Preparation task for the job. The Batch service runs the Job Release + task on the compute nodes that have run the Job Preparation task. + The primary purpose of the Job Release task is to undo changes to + compute nodes made by the Job Preparation task. Example activities + include deleting local files, or shutting down services that were + started as part of job preparation. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_66 + name: + fixed: false + raw: jobReleaseTask + realPath: + - jobReleaseTask + serializedName: jobReleaseTask + summary: The Job Release task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Individual tasks can override an environment setting specified here + by specifying the same setting name with a different value. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: commonEnvironmentSettings + realPath: + - commonEnvironmentSettings + serializedName: commonEnvironmentSettings + summary: >- + The list of common environment variable settings. These environment + variables are set for all tasks in the job (including the Job Manager, + Job Preparation and Job Release tasks). + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_67 + name: + fixed: false + raw: poolInfo + realPath: + - poolInfo + serializedName: poolInfo + summary: The pool on which the Batch service runs the job's tasks. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Note that if a job contains no tasks, then all tasks are considered + complete. This option is therefore most commonly used with a Job + Manager task; if you want to use automatic job termination without a + Job Manager, you should initially set onAllTasksComplete to noAction + and update the job properties to set onAllTasksComplete to + terminateJob once you have finished adding tasks. Permitted values + are: noAction - do nothing. The job remains active unless terminated + or disabled by some other means. terminateJob - terminate the job. + The job's terminateReason is set to 'AllTasksComplete'. The default + is noAction. + extensions: + x-ms-enum: + modelAsString: false + name: OnAllTasksComplete + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_61 + name: + fixed: false + raw: onAllTasksComplete + realPath: + - onAllTasksComplete + serializedName: onAllTasksComplete + summary: >- + The action the Batch service should take when all tasks in the job are + in the completed state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A task is considered to have failed if has a failureInfo. A + failureInfo is set if the task completes with a non-zero exit code + after exhausting its retry count, or if there was an error starting + the task, for example due to a resource file download error. + noAction - do nothing. performExitOptionsJobAction - take the action + associated with the task exit condition in the task's exitConditions + collection. (This may still result in no action being taken, if that + is what the task specifies.) The default is noAction. + extensions: + x-ms-enum: + modelAsString: false + name: OnTaskFailure + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_62 + name: + fixed: false + raw: onTaskFailure + realPath: + - onTaskFailure + serializedName: onTaskFailure + summary: >- + The action the Batch service should take when any task in the job + fails. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch service does not assign any meaning to metadata; it is + solely for the use of user code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the job as metadata. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: usesTaskDependencies + realPath: + - usesTaskDependencies + serializedName: usesTaskDependencies + summary: >- + Whether tasks in the job can define dependencies on each other. The + default is false. + serializedName: JobAddParameter + summary: An Azure Batch job to add. + - &ref_177 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CloudJobListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_80 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of jobs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: CloudJobListResult + summary: The result of listing the jobs in an account. + - &ref_82 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskContainerExecutionInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: containerId + realPath: + - containerId + serializedName: containerId + summary: The ID of the container. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the state of the container according to the Docker service. + It is equivalent to the status field returned by "docker inspect". + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The state of the container. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the detailed error string from the Docker service, if + available. It is equivalent to the error field returned by "docker + inspect". + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + summary: Detailed error information about the container. + serializedName: TaskContainerExecutionInformation + summary: Contains information about the container which a task is executing. + - &ref_83 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskFailureInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: ErrorCategory + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_75 + name: + fixed: false + raw: category + realPath: + - category + serializedName: category + summary: The category of the task error. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + summary: >- + An identifier for the task error. Codes are invariant and are intended + to be consumed programmatically. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + summary: >- + A message describing the task error, intended to be suitable for + display in a user interface. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_7 + name: + fixed: false + name: + fixed: false + raw: details + realPath: + - details + serializedName: details + summary: A list of additional details related to the error. + serializedName: TaskFailureInformation + summary: Information about a task failure. + - &ref_86 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobPreparationTaskExecutionInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the task has been restarted or retried, this is the most recent + time at which the task started running. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The time at which the task started running. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the task is in the Completed state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + summary: The time at which the Job Preparation task completed. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + running - the task is currently running (including retrying). + completed - the task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures). + extensions: + x-ms-enum: + modelAsString: false + name: JobPreparationTaskState + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_81 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The current state of the Job Preparation task on the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskRootDirectory + realPath: + - taskRootDirectory + serializedName: taskRootDirectory + summary: >- + The root directory of the Job Preparation task on the compute node. + You can use this path to retrieve files created by the task, such as + log files. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskRootDirectoryUrl + realPath: + - taskRootDirectoryUrl + serializedName: taskRootDirectoryUrl + summary: >- + The URL to the root directory of the Job Preparation task on the + compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This parameter is returned only if the task is in the completed + state. The exit code for a process reflects the specific convention + implemented by the application developer for that process. If you + use the exit code value to make decisions in your code, be sure that + you know the exit code convention used by the application process. + Note that the exit code may also be generated by the compute node + operating system, such as when a process is forcibly terminated. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: exitCode + realPath: + - exitCode + serializedName: exitCode + summary: The exit code of the program specified on the task command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the task runs in a container context. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_82 + name: + fixed: false + raw: containerInfo + realPath: + - containerInfo + serializedName: containerInfo + summary: Information about the container under which the task is executing. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the task is in the completed state and + encountered a failure. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_83 + name: + fixed: false + raw: failureInfo + realPath: + - failureInfo + serializedName: failureInfo + summary: 'Information describing the task failure, if any.' + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Task application failures (non-zero exit code) are retried, + pre-processing errors (the task could not be run) and file upload + errors are not retried. The Batch service will retry the task up to + the limit specified by the constraints. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: retryCount + realPath: + - retryCount + serializedName: retryCount + summary: >- + The number of times the task has been retried by the Batch service. + Task application failures (non-zero exit code) are retried, + pre-processing errors (the task could not be run) and file upload + errors are not retried. The Batch service will retry the task up to + the limit specified by the constraints. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the task was retried (i.e. retryCount + is nonzero). If present, this is typically the same as startTime, + but may be different if the task has been restarted for reasons + other than retry; for example, if the compute node was rebooted + during a retry, then the startTime is updated but the lastRetryTime + is not. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastRetryTime + realPath: + - lastRetryTime + serializedName: lastRetryTime + summary: >- + The most recent time at which a retry of the Job Preparation task + started running. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the value is 'failed', then the details of the failure can be + found in the failureInfo property. + extensions: + x-ms-enum: + modelAsString: false + name: TaskExecutionResult + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_84 + name: + fixed: false + raw: result + realPath: + - result + serializedName: result + summary: The result of the task execution. + serializedName: JobPreparationTaskExecutionInformation + summary: >- + Contains information about the execution of a Job Preparation task on a + compute node. + - &ref_87 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobReleaseTaskExecutionInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the task has been restarted or retried, this is the most recent + time at which the task started running. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The time at which the task started running. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the task is in the Completed state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + summary: The time at which the Job Release task completed. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + running - the task is currently running (including retrying). + completed - the task has exited, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures). + extensions: + x-ms-enum: + modelAsString: false + name: JobReleaseTaskState + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_85 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The current state of the Job Release task on the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskRootDirectory + realPath: + - taskRootDirectory + serializedName: taskRootDirectory + summary: >- + The root directory of the Job Release task on the compute node. You + can use this path to retrieve files created by the task, such as log + files. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskRootDirectoryUrl + realPath: + - taskRootDirectoryUrl + serializedName: taskRootDirectoryUrl + summary: >- + The URL to the root directory of the Job Release task on the compute + node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This parameter is returned only if the task is in the completed + state. The exit code for a process reflects the specific convention + implemented by the application developer for that process. If you + use the exit code value to make decisions in your code, be sure that + you know the exit code convention used by the application process. + Note that the exit code may also be generated by the compute node + operating system, such as when a process is forcibly terminated. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: exitCode + realPath: + - exitCode + serializedName: exitCode + summary: The exit code of the program specified on the task command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the task runs in a container context. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_82 + name: + fixed: false + raw: containerInfo + realPath: + - containerInfo + serializedName: containerInfo + summary: Information about the container under which the task is executing. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the task is in the completed state and + encountered a failure. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_83 + name: + fixed: false + raw: failureInfo + realPath: + - failureInfo + serializedName: failureInfo + summary: 'Information describing the task failure, if any.' + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the value is 'failed', then the details of the failure can be + found in the failureInfo property. + extensions: + x-ms-enum: + modelAsString: false + name: TaskExecutionResult + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_84 + name: + fixed: false + raw: result + realPath: + - result + serializedName: result + summary: The result of the task execution. + serializedName: JobReleaseTaskExecutionInformation + summary: >- + Contains information about the execution of a Job Release task on a + compute node. + - &ref_88 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobPreparationAndReleaseTaskExecutionInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + realPath: + - poolId + serializedName: poolId + summary: >- + The ID of the pool containing the compute node to which this entry + refers. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + realPath: + - nodeId + serializedName: nodeId + summary: The ID of the compute node to which this entry refers. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeUrl + realPath: + - nodeUrl + serializedName: nodeUrl + summary: The URL of the compute node to which this entry refers. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_86 + name: + fixed: false + raw: jobPreparationTaskExecutionInfo + realPath: + - jobPreparationTaskExecutionInfo + serializedName: jobPreparationTaskExecutionInfo + summary: >- + Information about the execution status of the Job Preparation task on + this compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the Job Release task has run on the + node. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_87 + name: + fixed: false + raw: jobReleaseTaskExecutionInfo + realPath: + - jobReleaseTaskExecutionInfo + serializedName: jobReleaseTaskExecutionInfo + summary: >- + Information about the execution status of the Job Release task on this + compute node. + serializedName: JobPreparationAndReleaseTaskExecutionInformation + summary: The status of the Job Preparation and Job Release tasks on a compute node. + - &ref_180 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CloudJobListPreparationAndReleaseTaskStatusResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_88 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: A list of Job Preparation and Job Release task execution information. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: CloudJobListPreparationAndReleaseTaskStatusResult + summary: >- + The result of listing the status of the Job Preparation and Job Release + tasks for a job. + - &ref_182 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskCounts + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: active + realPath: + - active + serializedName: active + summary: The number of tasks in the active state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: running + realPath: + - running + serializedName: running + summary: The number of tasks in the running or preparing state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: completed + realPath: + - completed + serializedName: completed + summary: The number of tasks in the completed state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: succeeded + realPath: + - succeeded + serializedName: succeeded + summary: >- + The number of tasks which succeeded. A task succeeds if its result + (found in the executionInfo property) is 'success'. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: failed + realPath: + - failed + serializedName: failed + summary: >- + The number of tasks which failed. A task fails if its result (found in + the executionInfo property) is 'failure'. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the validationStatus is unvalidated, then the Batch service has + not been able to check state counts against the task states as + reported in the List Tasks API. The validationStatus may be + unvalidated if the job contains more than 200,000 tasks. + extensions: + x-ms-enum: + modelAsString: false + name: TaskCountValidationStatus + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_89 + name: + fixed: false + raw: validationStatus + realPath: + - validationStatus + serializedName: validationStatus + summary: Whether the task counts have been validated. + serializedName: TaskCounts + summary: The task counts for a job. + - &ref_90 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AutoScaleRunError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + summary: >- + An identifier for the autoscale error. Codes are invariant and are + intended to be consumed programmatically. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + summary: >- + A message describing the autoscale error, intended to be suitable for + display in a user interface. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_7 + name: + fixed: false + name: + fixed: false + raw: values + realPath: + - values + serializedName: values + summary: A list of additional error details related to the autoscale error. + serializedName: AutoScaleRunError + summary: >- + An error that occurred when executing or evaluating a pool autoscale + formula. + - &ref_94 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AutoScaleRun + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: timestamp + realPath: + - timestamp + serializedName: timestamp + summary: The time at which the autoscale formula was last evaluated. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Each variable value is returned in the form $variable=value, and + variables are separated by semicolons. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: results + realPath: + - results + serializedName: results + summary: >- + The final values of all variables used in the evaluation of the + autoscale formula. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_90 + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + summary: >- + Details of the error encountered evaluating the autoscale formula on + the pool, if the evaluation was unsuccessful. + serializedName: AutoScaleRun + summary: The results and errors from an execution of a pool autoscale formula. + - &ref_93 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ResizeError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + summary: >- + An identifier for the pool resize error. Codes are invariant and are + intended to be consumed programmatically. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + summary: >- + A message describing the pool resize error, intended to be suitable + for display in a user interface. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_7 + name: + fixed: false + name: + fixed: false + raw: values + realPath: + - values + serializedName: values + summary: A list of additional error details related to the pool resize error. + serializedName: ResizeError + summary: An error that occurred when resizing a pool. + - &ref_97 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: CloudPool + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID can contain any combination of alphanumeric characters + including hyphens and underscores, and cannot contain more than 64 + characters. The ID is case-preserving and case-insensitive (that is, + you may not have two IDs within an account that differ only by + case). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the pool within the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The display name need not be unique and can contain any Unicode + characters up to a maximum length of 1024. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is an opaque string. You can use it to detect whether the pool + has changed between requests. In particular, you can be pass the + ETag when updating a pool to specify that your changes should take + effect only if nobody else has modified the pool in the meantime. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: eTag + realPath: + - eTag + serializedName: eTag + summary: The ETag of the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the last time at which the pool level data, such as the + targetDedicatedNodes or enableAutoscale settings, changed. It does + not factor in node-level changes such as a compute node changing + state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastModified + realPath: + - lastModified + serializedName: lastModified + summary: The last modified time of the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: creationTime + realPath: + - creationTime + serializedName: creationTime + summary: The creation time of the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + active - The pool is available to run tasks subject to the availability of compute nodes. + deleting - The user has requested that the pool be deleted, but the delete operation has not yet completed. + upgrading - The user has requested that the operating system of the pool's nodes be upgraded, but the upgrade operation has not yet completed (that is, some nodes in the pool have not yet been upgraded). While upgrading, the pool may be able to run tasks (with reduced capacity) but this is not guaranteed. + extensions: + x-ms-enum: + modelAsString: false + name: PoolState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_91 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The current state of the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: stateTransitionTime + realPath: + - stateTransitionTime + serializedName: stateTransitionTime + summary: The time at which the pool entered its current state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + steady - The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of dedicated nodes. + resizing - The pool is resizing; that is, compute nodes are being added to or removed from the pool. + stopping - The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. + extensions: + x-ms-enum: + modelAsString: false + name: AllocationState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_92 + name: + fixed: false + raw: allocationState + realPath: + - allocationState + serializedName: allocationState + summary: Whether the pool is resizing. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: allocationStateTransitionTime + realPath: + - allocationStateTransitionTime + serializedName: allocationStateTransitionTime + summary: The time at which the pool entered its current allocation state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For information about available sizes of virtual machines for Cloud + Services pools (pools created with cloudServiceConfiguration), see + Sizes for Cloud Services + (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). + Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 + and A2V2. For information about available VM sizes for pools using + images from the Virtual Machines Marketplace (pools created with + virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) + (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) + or Sizes for Virtual Machines (Windows) + (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). + Batch supports all Azure VM sizes except STANDARD_A0 and those with + premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 + series). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmSize + realPath: + - vmSize + serializedName: vmSize + summary: >- + The size of virtual machines in the pool. All virtual machines in a + pool are the same size. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property and virtualMachineConfiguration are mutually exclusive + and one of the properties must be specified. This property cannot be + specified if the Batch account was created with its + poolAllocationMode property set to 'UserSubscription'. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_50 + name: + fixed: false + raw: cloudServiceConfiguration + realPath: + - cloudServiceConfiguration + serializedName: cloudServiceConfiguration + summary: The cloud service configuration for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property and cloudServiceConfiguration are mutually exclusive + and one of the properties must be specified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_51 + name: + fixed: false + raw: virtualMachineConfiguration + realPath: + - virtualMachineConfiguration + serializedName: virtualMachineConfiguration + summary: The virtual machine configuration for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the timeout for the most recent resize operation. (The + initial sizing when the pool is created counts as a resize.) The + default value is 15 minutes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: resizeTimeout + realPath: + - resizeTimeout + serializedName: resizeTimeout + summary: The timeout for allocation of compute nodes to the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if one or more errors occurred during the + last pool resize, and only when the pool allocationState is Steady. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_93 + name: + fixed: false + name: + fixed: false + raw: resizeErrors + realPath: + - resizeErrors + serializedName: resizeErrors + summary: >- + A list of errors encountered while performing the last resize on the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: currentDedicatedNodes + realPath: + - currentDedicatedNodes + serializedName: currentDedicatedNodes + summary: The number of dedicated compute nodes currently in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Low-priority compute nodes which have been preempted are included in + this count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: currentLowPriorityNodes + realPath: + - currentLowPriorityNodes + serializedName: currentLowPriorityNodes + summary: The number of low-priority compute nodes currently in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetDedicatedNodes + realPath: + - targetDedicatedNodes + serializedName: targetDedicatedNodes + summary: The desired number of dedicated compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetLowPriorityNodes + realPath: + - targetLowPriorityNodes + serializedName: targetLowPriorityNodes + summary: The desired number of low-priority compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If false, at least one of targetDedicateNodes and + targetLowPriorityNodes must be specified. If true, the + autoScaleFormula property is required and the pool automatically + resizes according to the formula. The default value is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableAutoScale + realPath: + - enableAutoScale + serializedName: enableAutoScale + summary: Whether the pool size should automatically adjust over time. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the pool automatically scales, i.e. + enableAutoScale is true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: autoScaleFormula + realPath: + - autoScaleFormula + serializedName: autoScaleFormula + summary: A formula for the desired number of compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the pool automatically scales, i.e. + enableAutoScale is true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: autoScaleEvaluationInterval + realPath: + - autoScaleEvaluationInterval + serializedName: autoScaleEvaluationInterval + summary: >- + The time interval at which to automatically adjust the pool size + according to the autoscale formula. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the pool automatically scales, i.e. + enableAutoScale is true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_94 + name: + fixed: false + raw: autoScaleRun + realPath: + - autoScaleRun + serializedName: autoScaleRun + summary: >- + The results and errors from the last execution of the autoscale + formula. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This imposes restrictions on which nodes can be assigned to the + pool. Specifying this value can reduce the chance of the requested + number of nodes to be allocated in the pool. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableInterNodeCommunication + realPath: + - enableInterNodeCommunication + serializedName: enableInterNodeCommunication + summary: Whether the pool permits direct communication between nodes. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_53 + name: + fixed: false + raw: networkConfiguration + realPath: + - networkConfiguration + serializedName: networkConfiguration + summary: The network configuration for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_54 + name: + fixed: false + raw: startTask + realPath: + - startTask + serializedName: startTask + summary: A task specified to run on each compute node as it joins the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For Windows compute nodes, the Batch service installs the + certificates to the specified certificate store and location. For + Linux compute nodes, the certificates are stored in a directory + inside the task working directory and an environment variable + AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this + location. For certificates with visibility of 'remoteUser', a + 'certs' directory is created in the user's home directory (e.g., + /home/{user-name}/certs) and certificates are placed in that + directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_55 + name: + fixed: false + name: + fixed: false + raw: certificateReferences + realPath: + - certificateReferences + serializedName: certificateReferences + summary: >- + The list of certificates to be installed on each compute node in the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_34 + name: + fixed: false + name: + fixed: false + raw: applicationPackageReferences + realPath: + - applicationPackageReferences + serializedName: applicationPackageReferences + summary: >- + The list of application packages to be installed on each compute node + in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The list of application licenses must be a subset of available Batch + service application licenses. If a license is requested which is not + supported, pool creation will fail. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: applicationLicenses + realPath: + - applicationLicenses + serializedName: applicationLicenses + summary: >- + The list of application licenses the Batch service will make available + on each compute node in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxTasksPerNode + realPath: + - maxTasksPerNode + serializedName: maxTasksPerNode + summary: >- + The maximum number of tasks that can run concurrently on a single + compute node in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_52 + name: + fixed: false + raw: taskSchedulingPolicy + realPath: + - taskSchedulingPolicy + serializedName: taskSchedulingPolicy + summary: How tasks are distributed across compute nodes in a pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_56 + name: + fixed: false + name: + fixed: false + raw: userAccounts + realPath: + - userAccounts + serializedName: userAccounts + summary: The list of user accounts to be created on each node in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the pool as metadata. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_95 + name: + fixed: false + raw: stats + realPath: + - stats + serializedName: stats + summary: >- + Utilization and resource usage statistics for the entire lifetime of + the pool. + serializedName: CloudPool + summary: A pool in the Azure Batch service. + - &ref_138 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: PoolAddParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID can contain any combination of alphanumeric characters + including hyphens and underscores, and cannot contain more than 64 + characters. The ID is case-preserving and case-insensitive (that is, + you may not have two pool IDs within an account that differ only by + case). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the pool within the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The display name need not be unique and can contain any Unicode + characters up to a maximum length of 1024. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: The display name for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For information about available sizes of virtual machines for Cloud + Services pools (pools created with cloudServiceConfiguration), see + Sizes for Cloud Services + (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). + Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 + and A2V2. For information about available VM sizes for pools using + images from the Virtual Machines Marketplace (pools created with + virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) + (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) + or Sizes for Virtual Machines (Windows) + (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). + Batch supports all Azure VM sizes except STANDARD_A0 and those with + premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 + series). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmSize + realPath: + - vmSize + serializedName: vmSize + summary: >- + The size of virtual machines in the pool. All virtual machines in a + pool are the same size. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property and virtualMachineConfiguration are mutually exclusive + and one of the properties must be specified. This property cannot be + specified if the Batch account was created with its + poolAllocationMode property set to 'UserSubscription'. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_50 + name: + fixed: false + raw: cloudServiceConfiguration + realPath: + - cloudServiceConfiguration + serializedName: cloudServiceConfiguration + summary: The cloud service configuration for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property and cloudServiceConfiguration are mutually exclusive + and one of the properties must be specified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_51 + name: + fixed: false + raw: virtualMachineConfiguration + realPath: + - virtualMachineConfiguration + serializedName: virtualMachineConfiguration + summary: The virtual machine configuration for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This timeout applies only to manual scaling; it has no effect when + enableAutoScale is set to true. The default value is 15 minutes. The + minimum value is 5 minutes. If you specify a value less than 5 + minutes, the Batch service returns an error; if you are calling the + REST API directly, the HTTP status code is 400 (Bad Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: resizeTimeout + realPath: + - resizeTimeout + serializedName: resizeTimeout + summary: The timeout for allocation of compute nodes to the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must not be specified if enableAutoScale is set to + true. If enableAutoScale is set to false, then you must set either + targetDedicatedNodes, targetLowPriorityNodes, or both. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetDedicatedNodes + realPath: + - targetDedicatedNodes + serializedName: targetDedicatedNodes + summary: The desired number of dedicated compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must not be specified if enableAutoScale is set to + true. If enableAutoScale is set to false, then you must set either + targetDedicatedNodes, targetLowPriorityNodes, or both. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetLowPriorityNodes + realPath: + - targetLowPriorityNodes + serializedName: targetLowPriorityNodes + summary: The desired number of low-priority compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If false, at least one of targetDedicateNodes and + targetLowPriorityNodes must be specified. If true, the + autoScaleFormula property is required and the pool automatically + resizes according to the formula. The default value is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableAutoScale + realPath: + - enableAutoScale + serializedName: enableAutoScale + summary: Whether the pool size should automatically adjust over time. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property must not be specified if enableAutoScale is set to + false. It is required if enableAutoScale is set to true. The formula + is checked for validity before the pool is created. If the formula + is not valid, the Batch service rejects the request with detailed + error information. For more information about specifying this + formula, see 'Automatically scale compute nodes in an Azure Batch + pool' + (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: autoScaleFormula + realPath: + - autoScaleFormula + serializedName: autoScaleFormula + summary: A formula for the desired number of compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default value is 15 minutes. The minimum and maximum value are 5 + minutes and 168 hours respectively. If you specify a value less than + 5 minutes or greater than 168 hours, the Batch service returns an + error; if you are calling the REST API directly, the HTTP status + code is 400 (Bad Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: autoScaleEvaluationInterval + realPath: + - autoScaleEvaluationInterval + serializedName: autoScaleEvaluationInterval + summary: >- + The time interval at which to automatically adjust the pool size + according to the autoscale formula. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Enabling inter-node communication limits the maximum size of the + pool due to deployment restrictions on the nodes of the pool. This + may result in the pool not reaching its desired size. The default + value is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableInterNodeCommunication + realPath: + - enableInterNodeCommunication + serializedName: enableInterNodeCommunication + summary: Whether the pool permits direct communication between nodes. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_53 + name: + fixed: false + raw: networkConfiguration + realPath: + - networkConfiguration + serializedName: networkConfiguration + summary: The network configuration for the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The task runs when the node is added to the pool or when the node is + restarted. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_54 + name: + fixed: false + raw: startTask + realPath: + - startTask + serializedName: startTask + summary: A task specified to run on each compute node as it joins the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For Windows compute nodes, the Batch service installs the + certificates to the specified certificate store and location. For + Linux compute nodes, the certificates are stored in a directory + inside the task working directory and an environment variable + AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this + location. For certificates with visibility of 'remoteUser', a + 'certs' directory is created in the user's home directory (e.g., + /home/{user-name}/certs) and certificates are placed in that + directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_55 + name: + fixed: false + name: + fixed: false + raw: certificateReferences + realPath: + - certificateReferences + serializedName: certificateReferences + summary: >- + The list of certificates to be installed on each compute node in the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_34 + name: + fixed: false + name: + fixed: false + raw: applicationPackageReferences + realPath: + - applicationPackageReferences + serializedName: applicationPackageReferences + summary: >- + The list of application packages to be installed on each compute node + in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The list of application licenses must be a subset of available Batch + service application licenses. If a license is requested which is not + supported, pool creation will fail. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: applicationLicenses + realPath: + - applicationLicenses + serializedName: applicationLicenses + summary: >- + The list of application licenses the Batch service will make available + on each compute node in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default value is 1. The maximum value of this setting depends on + the size of the compute nodes in the pool (the vmSize setting). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxTasksPerNode + realPath: + - maxTasksPerNode + serializedName: maxTasksPerNode + summary: >- + The maximum number of tasks that can run concurrently on a single + compute node in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_52 + name: + fixed: false + raw: taskSchedulingPolicy + realPath: + - taskSchedulingPolicy + serializedName: taskSchedulingPolicy + summary: How tasks are distributed across compute nodes in a pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_56 + name: + fixed: false + name: + fixed: false + raw: userAccounts + realPath: + - userAccounts + serializedName: userAccounts + summary: The list of user accounts to be created on each node in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Batch service does not assign any meaning to metadata; it is + solely for the use of user code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the pool as metadata. + serializedName: PoolAddParameter + summary: A pool in the Azure Batch service to add. + - &ref_131 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ApplicationListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_96 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of applications available in the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: ApplicationListResult + summary: The result of listing the applications available in an account. + - &ref_140 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CloudPoolListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_97 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of pools. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: CloudPoolListResult + summary: The result of listing the pools in an account. + - &ref_101 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AffinityInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + You can pass the affinityId of a compute node to indicate that this + task needs to run on that compute node. Note that this is just a + soft affinity. If the target node is busy or unavailable at the time + the task is scheduled, then the task will be scheduled elsewhere. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: affinityId + realPath: + - affinityId + serializedName: affinityId + summary: >- + An opaque string representing the location of a compute node or a task + that has run previously. + serializedName: AffinityInformation + summary: >- + A locality hint that can be used by the Batch service to select a compute + node on which to start a task. + - &ref_102 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskExecutionInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 'Running' corresponds to the running state, so if the task specifies + resource files or application packages, then the start time reflects + the time at which the task started downloading or deploying these. + If the task has been restarted or retried, this is the most recent + time at which the task started running. This property is present + only for tasks that are in the running or completed state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The time at which the task started running. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the task is in the Completed state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + summary: The time at which the task completed. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the task is in the completed state. In + general, the exit code for a process reflects the specific + convention implemented by the application developer for that + process. If you use the exit code value to make decisions in your + code, be sure that you know the exit code convention used by the + application process. However, if the Batch service terminates the + task (due to timeout, or user termination via the API) you may see + an operating system-defined exit code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: exitCode + realPath: + - exitCode + serializedName: exitCode + summary: The exit code of the program specified on the task command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the task runs in a container context. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_82 + name: + fixed: false + raw: containerInfo + realPath: + - containerInfo + serializedName: containerInfo + summary: Information about the container under which the task is executing. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the task is in the completed state and + encountered a failure. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_83 + name: + fixed: false + raw: failureInfo + realPath: + - failureInfo + serializedName: failureInfo + summary: 'Information describing the task failure, if any.' + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Task application failures (non-zero exit code) are retried, + pre-processing errors (the task could not be run) and file upload + errors are not retried. The Batch service will retry the task up to + the limit specified by the constraints. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: retryCount + realPath: + - retryCount + serializedName: retryCount + summary: The number of times the task has been retried by the Batch service. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This element is present only if the task was retried (i.e. + retryCount is nonzero). If present, this is typically the same as + startTime, but may be different if the task has been restarted for + reasons other than retry; for example, if the compute node was + rebooted during a retry, then the startTime is updated but the + lastRetryTime is not. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastRetryTime + realPath: + - lastRetryTime + serializedName: lastRetryTime + summary: The most recent time at which a retry of the task started running. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When the user removes nodes from a pool (by resizing/shrinking the + pool) or when the job is being disabled, the user can specify that + running tasks on the nodes be requeued for execution. This count + tracks how many times the task has been requeued for these reasons. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: requeueCount + realPath: + - requeueCount + serializedName: requeueCount + summary: >- + The number of times the task has been requeued by the Batch service as + the result of a user request. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the requeueCount is nonzero. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastRequeueTime + realPath: + - lastRequeueTime + serializedName: lastRequeueTime + summary: >- + The most recent time at which the task has been requeued by the Batch + service as the result of a user request. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the value is 'failed', then the details of the failure can be + found in the failureInfo property. + extensions: + x-ms-enum: + modelAsString: false + name: TaskExecutionResult + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_84 + name: + fixed: false + raw: result + realPath: + - result + serializedName: result + summary: The result of the task execution. + serializedName: TaskExecutionInformation + summary: Information about the execution of a task. + - &ref_103 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ComputeNodeInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: affinityId + realPath: + - affinityId + serializedName: affinityId + summary: >- + An identifier for the compute node on which the task ran, which can be + passed when adding a task to request that the task be scheduled on + this compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeUrl + realPath: + - nodeUrl + serializedName: nodeUrl + summary: 'The URL of the node on which the task ran. ' + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + realPath: + - poolId + serializedName: poolId + summary: The ID of the pool on which the task ran. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + realPath: + - nodeId + serializedName: nodeId + summary: The ID of the node on which the task ran. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskRootDirectory + realPath: + - taskRootDirectory + serializedName: taskRootDirectory + summary: The root directory of the task on the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskRootDirectoryUrl + realPath: + - taskRootDirectoryUrl + serializedName: taskRootDirectoryUrl + summary: The URL to the root directory of the task on the compute node. + serializedName: ComputeNodeInformation + summary: Information about the compute node on which a task ran. + - &ref_104 + $type: CompositeType + containsConstantProperties: false + documentation: Multi-instance tasks are commonly used to support MPI tasks. + name: + fixed: false + raw: MultiInstanceSettings + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If omitted, the default is 1.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: numberOfInstances + realPath: + - numberOfInstances + serializedName: numberOfInstances + summary: The number of compute nodes required by the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A typical coordination command line launches a background service + and verifies that the service is ready to process inter-node + messages. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: coordinationCommandLine + realPath: + - coordinationCommandLine + serializedName: coordinationCommandLine + summary: >- + The command line to run on all the compute nodes to enable them to + coordinate when the primary runs the main task command. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The difference between common resource files and task resource files + is that common resource files are downloaded for all subtasks + including the primary, whereas task resource files are downloaded + only for the primary. Also note that these resource files are not + downloaded to the task working directory, but instead are downloaded + to the task root directory (one directory above the working + directory). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_29 + name: + fixed: false + name: + fixed: false + raw: commonResourceFiles + realPath: + - commonResourceFiles + serializedName: commonResourceFiles + summary: >- + A list of files that the Batch service will download before running + the coordination command line. + serializedName: MultiInstanceSettings + summary: Settings which specify how to run a multi-instance task. + - &ref_105 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskStatistics + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The start time of the time range covered by the statistics. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastUpdateTime + realPath: + - lastUpdateTime + serializedName: lastUpdateTime + summary: >- + The time at which the statistics were last updated. All statistics are + limited to the range between startTime and lastUpdateTime. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: userCPUTime + realPath: + - userCPUTime + serializedName: userCPUTime + summary: >- + The total user mode CPU time (summed across all cores and all compute + nodes) consumed by the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: kernelCPUTime + realPath: + - kernelCPUTime + serializedName: kernelCPUTime + summary: >- + The total kernel mode CPU time (summed across all cores and all + compute nodes) consumed by the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The wall clock time is the elapsed time from when the task started + running on a compute node to when it finished (or to the last time + the statistics were updated, if the task had not finished by then). + If the task was retried, this includes the wall clock time of all + the task retries. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: wallClockTime + realPath: + - wallClockTime + serializedName: wallClockTime + summary: The total wall clock time of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: readIOps + realPath: + - readIOps + serializedName: readIOps + summary: The total number of disk read operations made by the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: writeIOps + realPath: + - writeIOps + serializedName: writeIOps + summary: The total number of disk write operations made by the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: readIOGiB + realPath: + - readIOGiB + serializedName: readIOGiB + summary: The total gibibytes read from disk by the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: writeIOGiB + realPath: + - writeIOGiB + serializedName: writeIOGiB + summary: The total gibibytes written to disk by the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: waitTime + realPath: + - waitTime + serializedName: waitTime + summary: >- + The total wait time of the task. The wait time for a task is defined + as the elapsed time between the creation of the task and the start of + task execution. (If the task is retried due to failures, the wait time + is the time to the most recent task execution.) + serializedName: TaskStatistics + summary: Resource usage statistics for a task. + - &ref_98 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The start and end of the range are inclusive. For example, if a range has + start 9 and end 12, then it represents tasks '9', '10', '11' and '12'. + name: + fixed: false + raw: TaskIdRange + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: start + realPath: + - start + serializedName: start + summary: The first task ID in the range. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: end + realPath: + - end + serializedName: end + summary: The last task ID in the range. + serializedName: TaskIdRange + summary: >- + A range of task IDs that a task can depend on. All tasks with IDs in the + range must complete successfully before the dependent task can be + scheduled. + - &ref_106 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskDependencies + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The taskIds collection is limited to 64000 characters total (i.e. + the combined length of all task IDs). If the taskIds collection + exceeds the maximum length, the Add Task request fails with error + code TaskDependencyListTooLong. In this case consider using task ID + ranges instead. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: taskIds + realPath: + - taskIds + serializedName: taskIds + summary: >- + The list of task IDs that this task depends on. All tasks in this list + must complete successfully before the dependent task can be scheduled. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_98 + name: + fixed: false + name: + fixed: false + raw: taskIdRanges + realPath: + - taskIdRanges + serializedName: taskIdRanges + summary: >- + The list of task ID ranges that this task depends on. All tasks in all + ranges must complete successfully before the dependent task can be + scheduled. + serializedName: TaskDependencies + summary: >- + Specifies any dependencies of a task. Any task that is explicitly + specified or within a dependency range must complete before the dependant + task will be scheduled. + - &ref_115 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CloudTask + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID can contain any combination of alphanumeric characters + including hyphens and underscores, and cannot contain more than 64 + characters. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the task within the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The display name need not be unique and can contain any Unicode + characters up to a maximum length of 1024. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: A display name for the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is an opaque string. You can use it to detect whether the task + has changed between requests. In particular, you can be pass the + ETag when updating a task to specify that your changes should take + effect only if nobody else has modified the task in the meantime. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: eTag + realPath: + - eTag + serializedName: eTag + summary: The ETag of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastModified + realPath: + - lastModified + serializedName: lastModified + summary: The last modified time of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: creationTime + realPath: + - creationTime + serializedName: creationTime + summary: The creation time of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: How the Batch service should respond when the task completes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_99 + name: + fixed: false + raw: exitConditions + realPath: + - exitConditions + serializedName: exitConditions + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: TaskState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_100 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The current state of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: stateTransitionTime + realPath: + - stateTransitionTime + serializedName: stateTransitionTime + summary: The time at which the task entered its current state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is not set if the task is in its initial Active state. + extensions: + x-ms-enum: + modelAsString: false + name: TaskState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_100 + name: + fixed: false + raw: previousState + realPath: + - previousState + serializedName: previousState + summary: The previous state of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is not set if the task is in its initial Active state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: previousStateTransitionTime + realPath: + - previousStateTransitionTime + serializedName: previousStateTransitionTime + summary: The time at which the task entered its previous state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For multi-instance tasks, the command line is executed as the + primary task, after the primary task and all subtasks have finished + executing the coordination command line. The command line does not + run under a shell, and therefore cannot take advantage of shell + features such as environment variable expansion. If you want to take + advantage of such features, you should invoke the shell in the + command line, for example using "cmd /c MyCommand" in Windows or + "/bin/sh -c MyCommand" in Linux. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: commandLine + realPath: + - commandLine + serializedName: commandLine + summary: The command line of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the pool that will run this task has containerConfiguration set, + this must be set as well. If the pool that will run this task + doesn't have containerConfiguration set, this must not be set. When + this is specified, all directories recursively below the + AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the + node) are mapped into the container, all task environment variables + are mapped into the container, and the task command line is executed + in the container. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_28 + name: + fixed: false + raw: containerSettings + realPath: + - containerSettings + serializedName: containerSettings + summary: The settings for the container under which the task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For multi-instance tasks, the resource files will only be downloaded + to the compute node on which the primary task is executed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_29 + name: + fixed: false + name: + fixed: false + raw: resourceFiles + realPath: + - resourceFiles + serializedName: resourceFiles + summary: >- + A list of files that the Batch service will download to the compute + node before running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For multi-instance tasks, the files will only be uploaded from the + compute node on which the primary task is executed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_30 + name: + fixed: false + name: + fixed: false + raw: outputFiles + realPath: + - outputFiles + serializedName: outputFiles + summary: >- + A list of files that the Batch service will upload from the compute + node after running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: environmentSettings + realPath: + - environmentSettings + serializedName: environmentSettings + summary: A list of environment variable settings for the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_101 + name: + fixed: false + raw: affinityInfo + realPath: + - affinityInfo + serializedName: affinityInfo + summary: >- + A locality hint that can be used by the Batch service to select a + compute node on which to start the new task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_32 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + summary: The execution constraints that apply to this task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the task runs as a non-administrative user unique to the + task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_33 + name: + fixed: false + raw: userIdentity + realPath: + - userIdentity + serializedName: userIdentity + summary: The user identity under which the task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_102 + name: + fixed: false + raw: executionInfo + realPath: + - executionInfo + serializedName: executionInfo + summary: Information about the execution of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_103 + name: + fixed: false + raw: nodeInfo + realPath: + - nodeInfo + serializedName: nodeInfo + summary: Information about the compute node on which the task ran. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_104 + name: + fixed: false + raw: multiInstanceSettings + realPath: + - multiInstanceSettings + serializedName: multiInstanceSettings + summary: >- + An object that indicates that the task is a multi-instance task, and + contains information about how to run the multi-instance task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_105 + name: + fixed: false + raw: stats + realPath: + - stats + serializedName: stats + summary: Resource usage statistics for the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This task will not be scheduled until all tasks that it depends on + have completed successfully. If any of those tasks fail and exhaust + their retry counts, this task will never be scheduled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_106 + name: + fixed: false + raw: dependsOn + realPath: + - dependsOn + serializedName: dependsOn + summary: The tasks that this task depends on. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Application packages are downloaded and deployed to a shared + directory, not the task working directory. Therefore, if a + referenced package is already on the compute node, and is up to + date, then it is not re-downloaded; the existing copy on the compute + node is used. If a referenced application package cannot be + installed, for example because the package has been deleted or + because download failed, the task fails. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_34 + name: + fixed: false + name: + fixed: false + raw: applicationPackageReferences + realPath: + - applicationPackageReferences + serializedName: applicationPackageReferences + summary: >- + A list of application packages that the Batch service will deploy to + the compute node before running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If this property is set, the Batch service provides the task with an + authentication token which can be used to authenticate Batch service + operations without requiring an account access key. The token is + provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. + The operations that the task can carry out using the token depend on + the settings. For example, a task can request job permissions in + order to add other tasks to the job, or check the status of the job + or of other tasks under the job. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_35 + name: + fixed: false + raw: authenticationTokenSettings + realPath: + - authenticationTokenSettings + serializedName: authenticationTokenSettings + summary: >- + The settings for an authentication token that the task can use to + perform Batch service operations. + serializedName: CloudTask + summary: An Azure Batch task. + - &ref_107 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskAddParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID can contain any combination of alphanumeric characters + including hyphens and underscores, and cannot contain more than 64 + characters. The ID is case-preserving and case-insensitive (that is, + you may not have two IDs within a job that differ only by case). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: A string that uniquely identifies the task within the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The display name need not be unique and can contain any Unicode + characters up to a maximum length of 1024. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayName + realPath: + - displayName + serializedName: displayName + summary: A display name for the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For multi-instance tasks, the command line is executed as the + primary task, after the primary task and all subtasks have finished + executing the coordination command line. The command line does not + run under a shell, and therefore cannot take advantage of shell + features such as environment variable expansion. If you want to take + advantage of such features, you should invoke the shell in the + command line, for example using "cmd /c MyCommand" in Windows or + "/bin/sh -c MyCommand" in Linux. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: commandLine + realPath: + - commandLine + serializedName: commandLine + summary: The command line of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the pool that will run this task has containerConfiguration set, + this must be set as well. If the pool that will run this task + doesn't have containerConfiguration set, this must not be set. When + this is specified, all directories recursively below the + AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the + node) are mapped into the container, all task environment variables + are mapped into the container, and the task command line is executed + in the container. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_28 + name: + fixed: false + raw: containerSettings + realPath: + - containerSettings + serializedName: containerSettings + summary: The settings for the container under which the task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: How the Batch service should respond when the task completes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_99 + name: + fixed: false + raw: exitConditions + realPath: + - exitConditions + serializedName: exitConditions + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For multi-instance tasks, the resource files will only be downloaded + to the compute node on which the primary task is executed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_29 + name: + fixed: false + name: + fixed: false + raw: resourceFiles + realPath: + - resourceFiles + serializedName: resourceFiles + summary: >- + A list of files that the Batch service will download to the compute + node before running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For multi-instance tasks, the files will only be uploaded from the + compute node on which the primary task is executed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_30 + name: + fixed: false + name: + fixed: false + raw: outputFiles + realPath: + - outputFiles + serializedName: outputFiles + summary: >- + A list of files that the Batch service will upload from the compute + node after running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: environmentSettings + realPath: + - environmentSettings + serializedName: environmentSettings + summary: A list of environment variable settings for the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_101 + name: + fixed: false + raw: affinityInfo + realPath: + - affinityInfo + serializedName: affinityInfo + summary: >- + A locality hint that can be used by the Batch service to select a + compute node on which to start the new task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If you do not specify constraints, the maxTaskRetryCount is the + maxTaskRetryCount specified for the job, and the maxWallClockTime + and retentionTime are infinite. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_32 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + summary: The execution constraints that apply to this task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the task runs as a non-administrative user unique to the + task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_33 + name: + fixed: false + raw: userIdentity + realPath: + - userIdentity + serializedName: userIdentity + summary: The user identity under which the task runs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_104 + name: + fixed: false + raw: multiInstanceSettings + realPath: + - multiInstanceSettings + serializedName: multiInstanceSettings + summary: >- + An object that indicates that the task is a multi-instance task, and + contains information about how to run the multi-instance task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This task will not be scheduled until all tasks that it depends on + have completed successfully. If any of those tasks fail and exhaust + their retry counts, this task will never be scheduled. If the job + does not have usesTaskDependencies set to true, and this element is + present, the request fails with error code + TaskDependenciesNotSpecifiedOnJob. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_106 + name: + fixed: false + raw: dependsOn + realPath: + - dependsOn + serializedName: dependsOn + summary: The tasks that this task depends on. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Application packages are downloaded and deployed to a shared + directory, not the task working directory. Therefore, if a + referenced package is already on the compute node, and is up to + date, then it is not re-downloaded; the existing copy on the compute + node is used. If a referenced application package cannot be + installed, for example because the package has been deleted or + because download failed, the task fails. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_34 + name: + fixed: false + name: + fixed: false + raw: applicationPackageReferences + realPath: + - applicationPackageReferences + serializedName: applicationPackageReferences + summary: >- + A list of application packages that the Batch service will deploy to + the compute node before running the command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If this property is set, the Batch service provides the task with an + authentication token which can be used to authenticate Batch service + operations without requiring an account access key. The token is + provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. + The operations that the task can carry out using the token depend on + the settings. For example, a task can request job permissions in + order to add other tasks to the job, or check the status of the job + or of other tasks under the job. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_35 + name: + fixed: false + raw: authenticationTokenSettings + realPath: + - authenticationTokenSettings + serializedName: authenticationTokenSettings + summary: >- + The settings for an authentication token that the task can use to + perform Batch service operations. + serializedName: TaskAddParameter + summary: An Azure Batch task to add. + - &ref_219 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskAddCollectionParameter + properties: + - collectionFormat: none + constraints: + MaxItems: '100' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The total serialized size of this collection must be less than 4MB. + If it is greater than 4MB (for example if each task has 100's of + resource files or environment variables), the request will fail with + code 'RequestBodyTooLarge' and should be retried again with fewer + tasks. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_107 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The collection of tasks to add. + serializedName: TaskAddCollectionParameter + summary: A collection of Azure Batch tasks to add. + - *ref_108 + - *ref_109 + - *ref_110 + - &ref_112 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskAddResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + success - Task was added successfully. + clienterror - Task failed to add due to a client error and should not be retried without modifying the request as appropriate. + servererror - Task failed to add due to a server error and can be retried without modification. + extensions: + x-ms-enum: + name: TaskAddStatus + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_111 + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + summary: The status of the add task request. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + realPath: + - taskId + serializedName: taskId + summary: The ID of the task for which this is the result. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + You can use this to detect whether the task has changed between + requests. In particular, you can be pass the ETag with an Update + Task request to specify that your changes should take effect only if + nobody else has modified the job in the meantime. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: eTag + realPath: + - eTag + serializedName: eTag + summary: 'The ETag of the task, if the task was successfully added.' + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastModified + realPath: + - lastModified + serializedName: lastModified + summary: The last modified time of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + summary: 'The URL of the task, if the task was successfully added.' + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_110 + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + summary: The error encountered while attempting to add the task. + serializedName: TaskAddResult + summary: >- + Result for a single task added as part of an add task collection + operation. + - &ref_220 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskAddCollectionResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_112 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The results of the add task collection operation. + serializedName: TaskAddCollectionResult + summary: The result of adding a collection of tasks to a job. + - &ref_114 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: SubtaskInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: The ID of the subtask. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_103 + name: + fixed: false + raw: nodeInfo + realPath: + - nodeInfo + serializedName: nodeInfo + summary: Information about the compute node on which the subtask ran. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: >- + The time at which the subtask started running. If the subtask has been + restarted or retried, this is the most recent time at which the + subtask started running. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the subtask is in the Completed state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + summary: The time at which the subtask completed. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the subtask is in the completed state. + In general, the exit code for a process reflects the specific + convention implemented by the application developer for that + process. If you use the exit code value to make decisions in your + code, be sure that you know the exit code convention used by the + application process. However, if the Batch service terminates the + subtask (due to timeout, or user termination via the API) you may + see an operating system-defined exit code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: exitCode + realPath: + - exitCode + serializedName: exitCode + summary: The exit code of the program specified on the subtask command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the task runs in a container context. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_82 + name: + fixed: false + raw: containerInfo + realPath: + - containerInfo + serializedName: containerInfo + summary: Information about the container under which the task is executing. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the task is in the completed state and + encountered a failure. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_83 + name: + fixed: false + raw: failureInfo + realPath: + - failureInfo + serializedName: failureInfo + summary: 'Information describing the task failure, if any.' + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: SubtaskState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_113 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The current state of the subtask. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: stateTransitionTime + realPath: + - stateTransitionTime + serializedName: stateTransitionTime + summary: The time at which the subtask entered its current state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is not set if the subtask is in its initial running + state. + extensions: + x-ms-enum: + modelAsString: false + name: SubtaskState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_113 + name: + fixed: false + raw: previousState + realPath: + - previousState + serializedName: previousState + summary: The previous state of the subtask. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is not set if the subtask is in its initial running + state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: previousStateTransitionTime + realPath: + - previousStateTransitionTime + serializedName: previousStateTransitionTime + summary: The time at which the subtask entered its previous state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the value is 'failed', then the details of the failure can be + found in the failureInfo property. + extensions: + x-ms-enum: + modelAsString: false + name: TaskExecutionResult + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_84 + name: + fixed: false + raw: result + realPath: + - result + serializedName: result + summary: The result of the task execution. + serializedName: SubtaskInformation + summary: Information about an Azure Batch subtask. + - &ref_226 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CloudTaskListSubtasksResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_114 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of subtasks. + serializedName: CloudTaskListSubtasksResult + summary: The result of listing the subtasks of a task. + - &ref_217 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CloudTaskListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_115 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of tasks. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: CloudTaskListResult + summary: The result of listing the tasks in a job. + - &ref_120 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskUrl + realPath: + - taskUrl + serializedName: taskUrl + summary: The URL of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + realPath: + - jobId + serializedName: jobId + summary: The ID of the job to which the task belongs. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + realPath: + - taskId + serializedName: taskId + summary: The ID of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: subtaskId + realPath: + - subtaskId + serializedName: subtaskId + summary: The ID of the subtask if the task is a multi-instance task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: TaskState + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_100 + name: + fixed: false + raw: taskState + realPath: + - taskState + serializedName: taskState + summary: The current state of the task. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_102 + name: + fixed: false + raw: executionInfo + realPath: + - executionInfo + serializedName: executionInfo + summary: Information about the execution of the task. + serializedName: TaskInformation + summary: Information about a task running on a compute node. + - &ref_121 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: StartTaskInformation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + running - The start task is currently running. + completed - The start task has exited with exit code 0, or the start task has failed and the retry limit has reached, or the start task process did not run due to task preparation errors (such as resource file download failures). + extensions: + x-ms-enum: + modelAsString: false + name: StartTaskState + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_116 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The state of the start task on the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This value is reset every time the task is restarted or retried + (that is, this is the most recent time at which the start task + started running). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + summary: The time at which the start task started running. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the end time of the most recent run of the start task, if + that run has completed (even if that run failed and a retry is + pending). This element is not present if the start task is currently + running. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + summary: The time at which the start task stopped running. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the start task is in the completed + state. In general, the exit code for a process reflects the specific + convention implemented by the application developer for that + process. If you use the exit code value to make decisions in your + code, be sure that you know the exit code convention used by the + application process. However, if the Batch service terminates the + start task (due to timeout, or user termination via the API) you may + see an operating system-defined exit code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: exitCode + realPath: + - exitCode + serializedName: exitCode + summary: The exit code of the program specified on the start task command line. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property is set only if the task runs in a container context. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_82 + name: + fixed: false + raw: containerInfo + realPath: + - containerInfo + serializedName: containerInfo + summary: Information about the container under which the task is executing. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is set only if the task is in the completed state and + encountered a failure. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_83 + name: + fixed: false + raw: failureInfo + realPath: + - failureInfo + serializedName: failureInfo + summary: 'Information describing the task failure, if any.' + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Task application failures (non-zero exit code) are retried, + pre-processing errors (the task could not be run) and file upload + errors are not retried. The Batch service will retry the task up to + the limit specified by the constraints. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: retryCount + realPath: + - retryCount + serializedName: retryCount + summary: The number of times the task has been retried by the Batch service. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This element is present only if the task was retried (i.e. + retryCount is nonzero). If present, this is typically the same as + startTime, but may be different if the task has been restarted for + reasons other than retry; for example, if the compute node was + rebooted during a retry, then the startTime is updated but the + lastRetryTime is not. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastRetryTime + realPath: + - lastRetryTime + serializedName: lastRetryTime + summary: The most recent time at which a retry of the task started running. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If the value is 'failed', then the details of the failure can be + found in the failureInfo property. + extensions: + x-ms-enum: + modelAsString: false + name: TaskExecutionResult + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_84 + name: + fixed: false + raw: result + realPath: + - result + serializedName: result + summary: The result of the task execution. + serializedName: StartTaskInformation + summary: Information about a start task running on a compute node. + - &ref_122 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ComputeNodeError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + summary: >- + An identifier for the compute node error. Codes are invariant and are + intended to be consumed programmatically. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + summary: >- + A message describing the compute node error, intended to be suitable + for display in a user interface. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_7 + name: + fixed: false + name: + fixed: false + raw: errorDetails + realPath: + - errorDetails + serializedName: errorDetails + summary: >- + The list of additional error details related to the compute node + error. + serializedName: ComputeNodeError + summary: An error encountered by a compute node. + - &ref_117 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: InboundEndpoint + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + summary: The name of the endpoint. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: InboundEndpointProtocol + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_46 + name: + fixed: false + raw: protocol + realPath: + - protocol + serializedName: protocol + summary: The protocol of the endpoint. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publicIPAddress + realPath: + - publicIPAddress + serializedName: publicIPAddress + summary: The public IP address of the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publicFQDN + realPath: + - publicFQDN + serializedName: publicFQDN + summary: The public fully qualified domain name for the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: frontendPort + realPath: + - frontendPort + serializedName: frontendPort + summary: The public port number of the endpoint. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: backendPort + realPath: + - backendPort + serializedName: backendPort + summary: The backend port number of the endpoint. + serializedName: InboundEndpoint + summary: An inbound endpoint on a compute node. + - &ref_123 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ComputeNodeEndpointConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_117 + name: + fixed: false + name: + fixed: false + raw: inboundEndpoints + realPath: + - inboundEndpoints + serializedName: inboundEndpoints + summary: The list of inbound endpoints that are accessible on the compute node. + serializedName: ComputeNodeEndpointConfiguration + summary: The endpoint configuration for the compute node. + - &ref_124 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ComputeNode + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Every node that is added to a pool is assigned a unique ID. Whenever + a node is removed from a pool, all of its local files are deleted, + and the ID is reclaimed and could be reused for new nodes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + summary: The ID of the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + summary: The URL of the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + idle - The node is not currently running a task. + rebooting - The node is rebooting. + reimaging - The node is reimaging. + running - The node is running one or more tasks (other than a start task). + unusable - The node cannot be used for task execution due to errors. + creating - The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool. + starting - the Batch service is starting on the underlying virtual machine. + waitingforstarttask - The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed. + starttaskfailed - The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set. The node is not usable for running tasks. + unknown - The Batch service has lost contact with the node, and does not know its true state. + leavingpool - The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down. + offline - The node is not currently running a task, and scheduling of new tasks to the node is disabled. + preempted - The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available. + extensions: + x-ms-enum: + modelAsString: false + name: ComputeNodeState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_118 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + summary: The current state of the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + enabled - Tasks can be scheduled on the node. + disabled - No new tasks will be scheduled on the node. Tasks already running on the node may still run to completion. All nodes start with scheduling enabled. + extensions: + x-ms-enum: + modelAsString: false + name: SchedulingState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_119 + name: + fixed: false + raw: schedulingState + realPath: + - schedulingState + serializedName: schedulingState + summary: Whether the compute node is available for task scheduling. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: stateTransitionTime + realPath: + - stateTransitionTime + serializedName: stateTransitionTime + summary: The time at which the compute node entered its current state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This property may not be present if the node state is unusable. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastBootTime + realPath: + - lastBootTime + serializedName: lastBootTime + summary: The time at which the compute node was started. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: allocationTime + realPath: + - allocationTime + serializedName: allocationTime + summary: The time at which this compute node was allocated to the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Every node that is added to a pool is assigned a unique IP address. + Whenever a node is removed from a pool, all of its local files are + deleted, and the IP address is reclaimed and could be reused for new + nodes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ipAddress + realPath: + - ipAddress + serializedName: ipAddress + summary: >- + The IP address that other compute nodes can use to communicate with + this compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Note that this is just a soft affinity. If the target node is busy + or unavailable at the time the task is scheduled, then the task will + be scheduled elsewhere. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: affinityId + realPath: + - affinityId + serializedName: affinityId + summary: >- + An identifier which can be passed when adding a task to request that + the task be scheduled on this node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For information about available sizes of virtual machines for Cloud + Services pools (pools created with cloudServiceConfiguration), see + Sizes for Cloud Services + (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). + Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 + and A2V2. For information about available VM sizes for pools using + images from the Virtual Machines Marketplace (pools created with + virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) + (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) + or Sizes for Virtual Machines (Windows) + (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). + Batch supports all Azure VM sizes except STANDARD_A0 and those with + premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 + series). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmSize + realPath: + - vmSize + serializedName: vmSize + summary: The size of the virtual machine hosting the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: totalTasksRun + realPath: + - totalTasksRun + serializedName: totalTasksRun + summary: >- + The total number of job tasks completed on the compute node. This + includes Job Manager tasks and normal tasks, but not Job Preparation, + Job Release or Start tasks. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: runningTasksCount + realPath: + - runningTasksCount + serializedName: runningTasksCount + summary: >- + The total number of currently running job tasks on the compute node. + This includes Job Manager tasks and normal tasks, but not Job + Preparation, Job Release or Start tasks. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: totalTasksSucceeded + realPath: + - totalTasksSucceeded + serializedName: totalTasksSucceeded + summary: >- + The total number of job tasks which completed successfully (with + exitCode 0) on the compute node. This includes Job Manager tasks and + normal tasks, but not Job Preparation, Job Release or Start tasks. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property is present only if at least one task has run on this + node since it was assigned to the pool. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_120 + name: + fixed: false + name: + fixed: false + raw: recentTasks + realPath: + - recentTasks + serializedName: recentTasks + summary: A list of tasks whose state has recently changed. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_54 + name: + fixed: false + raw: startTask + realPath: + - startTask + serializedName: startTask + summary: The task specified to run on the compute node as it joins the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_121 + name: + fixed: false + raw: startTaskInfo + realPath: + - startTaskInfo + serializedName: startTaskInfo + summary: >- + Runtime information about the execution of the start task on the + compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For Windows compute nodes, the Batch service installs the + certificates to the specified certificate store and location. For + Linux compute nodes, the certificates are stored in a directory + inside the task working directory and an environment variable + AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this + location. For certificates with visibility of 'remoteUser', a + 'certs' directory is created in the user's home directory (e.g., + /home/{user-name}/certs) and certificates are placed in that + directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_55 + name: + fixed: false + name: + fixed: false + raw: certificateReferences + realPath: + - certificateReferences + serializedName: certificateReferences + summary: The list of certificates installed on the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_122 + name: + fixed: false + name: + fixed: false + raw: errors + realPath: + - errors + serializedName: errors + summary: >- + The list of errors that are currently being encountered by the compute + node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isDedicated + realPath: + - isDedicated + serializedName: isDedicated + summary: >- + Whether this compute node is a dedicated node. If false, the node is a + low-priority node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_123 + name: + fixed: false + raw: endpointConfiguration + realPath: + - endpointConfiguration + serializedName: endpointConfiguration + summary: The endpoint configuration for the compute node. + serializedName: ComputeNode + summary: A compute node in the Batch service. + - &ref_247 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ComputeNodeListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_124 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + summary: The list of compute nodes. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: odata.nextLink + realPath: + - odata.nextLink + serializedName: odata.nextLink + summary: The URL to get the next set of results. + serializedName: ComputeNodeListResult + summary: The result of listing the compute nodes in a pool. + - &ref_230 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ComputeNodeUser + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + summary: The user name of the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The default value is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isAdmin + realPath: + - isAdmin + serializedName: isAdmin + summary: Whether the account should be an administrator on the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the default is 1 day from the current time. For Linux + compute nodes, the expiryTime has a precision up to a day. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: expiryTime + realPath: + - expiryTime + serializedName: expiryTime + summary: The time at which the account should expire. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The password is required for Windows nodes (those created with + 'cloudServiceConfiguration', or created with + 'virtualMachineConfiguration' using a Windows image reference). For + Linux compute nodes, the password can optionally be specified along + with the sshPublicKey property. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: password + realPath: + - password + serializedName: password + summary: The password of the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The public key should be compatible with OpenSSH encoding and should + be base 64 encoded. This property can be specified only for Linux + nodes. If this is specified for a Windows node, then the Batch + service rejects the request; if you are calling the REST API + directly, the HTTP status code is 400 (Bad Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sshPublicKey + realPath: + - sshPublicKey + serializedName: sshPublicKey + summary: >- + The SSH public key that can be used for remote login to the compute + node. + serializedName: ComputeNodeUser + summary: A user account for RDP or SSH access on a compute node. + - &ref_243 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ComputeNodeGetRemoteLoginSettingsResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: remoteLoginIPAddress + realPath: + - remoteLoginIPAddress + serializedName: remoteLoginIPAddress + summary: The IP address used for remote login to the compute node. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: remoteLoginPort + realPath: + - remoteLoginPort + serializedName: remoteLoginPort + summary: The port used for remote login to the compute node. + serializedName: ComputeNodeGetRemoteLoginSettingsResult + summary: The remote login settings for a compute node. + - &ref_205 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: JobSchedulePatchParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If you do not specify this element, the existing schedule is left + unchanged. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_70 + name: + fixed: false + raw: schedule + realPath: + - schedule + serializedName: schedule + summary: The schedule according to which jobs will be created. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Updates affect only jobs that are started after the update has taken + place. Any currently active job continues with the older + specification. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_71 + name: + fixed: false + raw: jobSpecification + realPath: + - jobSpecification + serializedName: jobSpecification + summary: The details of the jobs to be created on this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If you do not specify this element, existing metadata is left + unchanged. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: >- + A list of name-value pairs associated with the job schedule as + metadata. + serializedName: JobSchedulePatchParameter + summary: The set of changes to be made to a job schedule. + - &ref_207 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: JobScheduleUpdateParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If you do not specify this element, it is equivalent to passing the + default schedule: that is, a single job scheduled to run + immediately. + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_70 + name: + fixed: false + raw: schedule + realPath: + - schedule + serializedName: schedule + summary: The schedule according to which jobs will be created. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Updates affect only jobs that are started after the update has taken + place. Any currently active job continues with the older + specification. + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_71 + name: + fixed: false + raw: jobSpecification + realPath: + - jobSpecification + serializedName: jobSpecification + summary: Details of the jobs to be created on this schedule. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If you do not specify this element, it takes the default value of an + empty list; in effect, any existing metadata is deleted. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: >- + A list of name-value pairs associated with the job schedule as + metadata. + serializedName: JobScheduleUpdateParameter + summary: The set of changes to be made to a job schedule. + - &ref_170 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobDisableParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + requeue - Terminate running tasks and requeue them. The tasks will run again when the job is enabled. + terminate - Terminate running tasks. The tasks will not run again. + wait - Allow currently running tasks to complete. + extensions: + x-ms-enum: + modelAsString: false + name: DisableJobOption + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_125 + name: + fixed: false + raw: disableTasks + realPath: + - disableTasks + serializedName: disableTasks + summary: What to do with active tasks associated with the job. + serializedName: JobDisableParameter + summary: Options when disabling a job. + - &ref_173 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: JobTerminateParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: terminateReason + realPath: + - terminateReason + serializedName: terminateReason + summary: >- + The text you want to appear as the job's TerminateReason. The default + is 'UserTerminate'. + serializedName: JobTerminateParameter + summary: Options when terminating a job. + - &ref_166 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: JobPatchParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Priority values can range from -1000 to 1000, with -1000 being the + lowest priority and 1000 being the highest priority. If omitted, the + priority of the job is left unchanged. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: priority + realPath: + - priority + serializedName: priority + summary: The priority of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the completion behavior is left unchanged. You may not + change the value from terminateJob to noAction - that is, once you + have engaged automatic job termination, you cannot turn it off + again. If you try to do this, the request fails with an 'invalid + property value' error response; if you are calling the REST API + directly, the HTTP status code is 400 (Bad Request). + extensions: + x-ms-enum: + modelAsString: false + name: OnAllTasksComplete + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_61 + name: + fixed: false + raw: onAllTasksComplete + realPath: + - onAllTasksComplete + serializedName: onAllTasksComplete + summary: >- + The action the Batch service should take when all tasks in the job are + in the completed state. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If omitted, the existing execution constraints are left unchanged.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_63 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + summary: The execution constraints for the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + You may change the pool for a job only when the job is disabled. The + Patch Job call will fail if you include the poolInfo element and the + job is not disabled. If you specify an autoPoolSpecification + specification in the poolInfo, only the keepAlive property can be + updated, and then only if the auto pool has a poolLifetimeOption of + job. If omitted, the job continues to run on its current pool. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_67 + name: + fixed: false + raw: poolInfo + realPath: + - poolInfo + serializedName: poolInfo + summary: The pool on which the Batch service runs the job's tasks. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If omitted, the existing job metadata is left unchanged.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the job as metadata. + serializedName: JobPatchParameter + summary: The set of changes to be made to a job. + - &ref_168 + $type: CompositeType + containsConstantProperties: true + name: + fixed: false + raw: JobUpdateParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Priority values can range from -1000 to 1000, with -1000 being the + lowest priority and 1000 being the highest priority. If omitted, it + is set to the default value 0. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: priority + realPath: + - priority + serializedName: priority + summary: The priority of the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If omitted, the constraints are cleared.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_63 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + summary: The execution constraints for the job. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + You may change the pool for a job only when the job is disabled. The + Update Job call will fail if you include the poolInfo element and + the job is not disabled. If you specify an autoPoolSpecification + specification in the poolInfo, only the keepAlive property can be + updated, and then only if the auto pool has a poolLifetimeOption of + job. + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_67 + name: + fixed: false + raw: poolInfo + realPath: + - poolInfo + serializedName: poolInfo + summary: The pool on which the Batch service runs the job's tasks. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, it takes the default value of an empty list; in effect, + any existing metadata is deleted. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the job as metadata. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the completion behavior is set to noAction. If the + current value is terminateJob, this is an error because a job's + completion behavior may not be changed from terminateJob to + noAction. You may not change the value from terminatejob to noaction + - that is, once you have engaged automatic job termination, you + cannot turn it off again. If you try to do this, the request fails + and Batch returns status code 400 (Bad Request) and an 'invalid + property value' error response. If you do not specify this element + in a PUT request, it is equivalent to passing noaction. This is an + error if the current value is terminatejob. + extensions: + x-ms-enum: + modelAsString: false + name: OnAllTasksComplete + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_61 + name: + fixed: false + raw: onAllTasksComplete + realPath: + - onAllTasksComplete + serializedName: onAllTasksComplete + summary: >- + The action the Batch service should take when all tasks in the job are + in the completed state. + serializedName: JobUpdateParameter + summary: The set of changes to be made to a job. + - &ref_148 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolEnableAutoScaleParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The formula is checked for validity before it is applied to the + pool. If the formula is not valid, the Batch service rejects the + request with detailed error information. For more information about + specifying this formula, see Automatically scale compute nodes in an + Azure Batch pool + (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: autoScaleFormula + realPath: + - autoScaleFormula + serializedName: autoScaleFormula + summary: The formula for the desired number of compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default value is 15 minutes. The minimum and maximum value are 5 + minutes and 168 hours respectively. If you specify a value less than + 5 minutes or greater than 168 hours, the Batch service rejects the + request with an invalid property value error; if you are calling the + REST API directly, the HTTP status code is 400 (Bad Request). If you + specify a new interval, then the existing autoscale evaluation + schedule will be stopped and a new autoscale evaluation schedule + will be started, with its starting time being the time when this + request was issued. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: autoScaleEvaluationInterval + realPath: + - autoScaleEvaluationInterval + serializedName: autoScaleEvaluationInterval + summary: >- + The time interval at which to automatically adjust the pool size + according to the autoscale formula. + serializedName: PoolEnableAutoScaleParameter + summary: Options for enabling automatic scaling on a pool. + - &ref_150 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolEvaluateAutoScaleParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The formula is validated and its results calculated, but it is not + applied to the pool. To apply the formula to the pool, 'Enable + automatic scaling on a pool'. For more information about specifying + this formula, see Automatically scale compute nodes in an Azure + Batch pool + (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: autoScaleFormula + realPath: + - autoScaleFormula + serializedName: autoScaleFormula + summary: The formula for the desired number of compute nodes in the pool. + serializedName: PoolEvaluateAutoScaleParameter + summary: Options for evaluating an automatic scaling formula on a pool. + - &ref_152 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolResizeParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetDedicatedNodes + realPath: + - targetDedicatedNodes + serializedName: targetDedicatedNodes + summary: The desired number of dedicated compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetLowPriorityNodes + realPath: + - targetLowPriorityNodes + serializedName: targetLowPriorityNodes + summary: The desired number of low-priority compute nodes in the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default value is 15 minutes. The minimum value is 5 minutes. If + you specify a value less than 5 minutes, the Batch service returns + an error; if you are calling the REST API directly, the HTTP status + code is 400 (Bad Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: resizeTimeout + realPath: + - resizeTimeout + serializedName: resizeTimeout + summary: >- + The timeout for allocation of compute nodes to the pool or removal of + compute nodes from the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The default value is requeue. + extensions: + x-ms-enum: + modelAsString: false + name: ComputeNodeDeallocationOption + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_126 + name: + fixed: false + raw: nodeDeallocationOption + realPath: + - nodeDeallocationOption + serializedName: nodeDeallocationOption + summary: >- + Determines what to do with a node and its running task(s) if the pool + size is decreasing. + serializedName: PoolResizeParameter + summary: Options for changing the size of a pool. + - &ref_155 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolUpdatePropertiesParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If this element is present, it overwrites any existing start task. + If omitted, any existing start task is removed from the pool. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_54 + name: + fixed: false + raw: startTask + realPath: + - startTask + serializedName: startTask + summary: >- + A task to run on each compute node as it joins the pool. The task runs + when the node is added to the pool or when the node is restarted. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This list replaces any existing certificate references configured on + the pool. If you specify an empty collection, any existing + certificate references are removed from the pool. For Windows + compute nodes, the Batch service installs the certificates to the + specified certificate store and location. For Linux compute nodes, + the certificates are stored in a directory inside the task working + directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is + supplied to the task to query for this location. For certificates + with visibility of 'remoteUser', a 'certs' directory is created in + the user's home directory (e.g., /home/{user-name}/certs) and + certificates are placed in that directory. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_55 + name: + fixed: false + name: + fixed: false + raw: certificateReferences + realPath: + - certificateReferences + serializedName: certificateReferences + summary: >- + A list of certificates to be installed on each compute node in the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The list replaces any existing application package references on the + pool. Changes to application package references affect all new + compute nodes joining the pool, but do not affect compute nodes that + are already in the pool until they are rebooted or reimaged. If + omitted, or if you specify an empty collection, any existing + application packages references are removed from the pool. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_34 + name: + fixed: false + name: + fixed: false + raw: applicationPackageReferences + realPath: + - applicationPackageReferences + serializedName: applicationPackageReferences + summary: >- + A list of application packages to be installed on each compute node in + the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This list replaces any existing metadata configured on the pool. If + omitted, or if you specify an empty collection, any existing + metadata is removed from the pool. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the pool as metadata. + serializedName: PoolUpdatePropertiesParameter + summary: The set of changes to be made to a pool. + - &ref_157 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolUpgradeOSParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: targetOSVersion + realPath: + - targetOSVersion + serializedName: targetOSVersion + summary: >- + The Azure Guest OS version to be installed on the virtual machines in + the pool. + serializedName: PoolUpgradeOSParameter + summary: Options for upgrading the operating system of compute nodes in a pool. + - &ref_145 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PoolPatchParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If this element is present, it overwrites any existing start task. + If omitted, any existing start task is left unchanged. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_54 + name: + fixed: false + raw: startTask + realPath: + - startTask + serializedName: startTask + summary: >- + A task to run on each compute node as it joins the pool. The task runs + when the node is added to the pool or when the node is restarted. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If this element is present, it replaces any existing certificate + references configured on the pool. If omitted, any existing + certificate references are left unchanged. For Windows compute + nodes, the Batch service installs the certificates to the specified + certificate store and location. For Linux compute nodes, the + certificates are stored in a directory inside the task working + directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is + supplied to the task to query for this location. For certificates + with visibility of 'remoteUser', a 'certs' directory is created in + the user's home directory (e.g., /home/{user-name}/certs) and + certificates are placed in that directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_55 + name: + fixed: false + name: + fixed: false + raw: certificateReferences + realPath: + - certificateReferences + serializedName: certificateReferences + summary: >- + A list of certificates to be installed on each compute node in the + pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Changes to application package references affect all new compute + nodes joining the pool, but do not affect compute nodes that are + already in the pool until they are rebooted or reimaged. If this + element is present, it replaces any existing application package + references. If you specify an empty collection, then all application + package references are removed from the pool. If omitted, any + existing application package references are left unchanged. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_34 + name: + fixed: false + name: + fixed: false + raw: applicationPackageReferences + realPath: + - applicationPackageReferences + serializedName: applicationPackageReferences + summary: >- + A list of application packages to be installed on each compute node in + the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If this element is present, it replaces any existing metadata + configured on the pool. If you specify an empty collection, any + metadata is removed from the pool. If omitted, any existing metadata + is left unchanged. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: metadata + realPath: + - metadata + serializedName: metadata + summary: A list of name-value pairs associated with the pool as metadata. + serializedName: PoolPatchParameter + summary: The set of changes to be made to a pool. + - &ref_224 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: TaskUpdateParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the task is given the default constraints. For + multi-instance tasks, updating the retention time applies only to + the primary task and not subtasks. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_32 + name: + fixed: false + raw: constraints + realPath: + - constraints + serializedName: constraints + summary: Constraints that apply to this task. + serializedName: TaskUpdateParameter + summary: The set of changes to be made to a task. + - &ref_233 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NodeUpdateUserParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The password is required for Windows nodes (those created with + 'cloudServiceConfiguration', or created with + 'virtualMachineConfiguration' using a Windows image reference). For + Linux compute nodes, the password can optionally be specified along + with the sshPublicKey property. If omitted, any existing password is + removed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: password + realPath: + - password + serializedName: password + summary: The password of the account. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If omitted, the default is 1 day from the current time. For Linux + compute nodes, the expiryTime has a precision up to a day. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: expiryTime + realPath: + - expiryTime + serializedName: expiryTime + summary: The time at which the account should expire. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The public key should be compatible with OpenSSH encoding and should + be base 64 encoded. This property can be specified only for Linux + nodes. If this is specified for a Windows node, then the Batch + service rejects the request; if you are calling the REST API + directly, the HTTP status code is 400 (Bad Request). If omitted, any + existing SSH public key is removed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sshPublicKey + realPath: + - sshPublicKey + serializedName: sshPublicKey + summary: >- + The SSH public key that can be used for remote login to the compute + node. + serializedName: NodeUpdateUserParameter + summary: The set of changes to be made to a user account on a node. + - &ref_236 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NodeRebootParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + requeue - Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Restart the node as soon as tasks have been terminated. + terminate - Terminate running tasks. The tasks will not run again. Restart the node as soon as tasks have been terminated. + taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Restart the node when all tasks have completed. + retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Restart the node when all task retention periods have expired. + + The default value is requeue. + extensions: + x-ms-enum: + modelAsString: false + name: ComputeNodeRebootOption + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_127 + name: + fixed: false + raw: nodeRebootOption + realPath: + - nodeRebootOption + serializedName: nodeRebootOption + summary: >- + When to reboot the compute node and what to do with currently running + tasks. + serializedName: NodeRebootParameter + summary: Options for rebooting a compute node. + - &ref_238 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NodeReimageParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + requeue - Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Reimage the node as soon as tasks have been terminated. + terminate - Terminate running tasks. The tasks will not run again. Reimage the node as soon as tasks have been terminated. + taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Reimage the node when all tasks have completed. + retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Reimage the node when all task retention periods have expired. + + The default value is requeue. + extensions: + x-ms-enum: + modelAsString: false + name: ComputeNodeReimageOption + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_128 + name: + fixed: false + raw: nodeReimageOption + realPath: + - nodeReimageOption + serializedName: nodeReimageOption + summary: >- + When to reimage the compute node and what to do with currently running + tasks. + serializedName: NodeReimageParameter + summary: Options for reimaging a compute node. + - &ref_240 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NodeDisableSchedulingParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Values are: + + requeue - Terminate running task processes and requeue the tasks. The tasks may run again on other compute nodes, or when task scheduling is re-enabled on this node. Enter offline state as soon as tasks have been terminated. + terminate - Terminate running tasks. The tasks will not run again. Enter offline state as soon as tasks have been terminated. + taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Enter offline state when all tasks have completed. + + The default value is requeue. + extensions: + x-ms-enum: + modelAsString: false + name: DisableComputeNodeSchedulingOption + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_129 + name: + fixed: false + raw: nodeDisableSchedulingOption + realPath: + - nodeDisableSchedulingOption + serializedName: nodeDisableSchedulingOption + summary: >- + What to do with currently running tasks when disabling task scheduling + on the compute node. + serializedName: NodeDisableSchedulingParameter + summary: Options for disabling scheduling on a compute node. + - &ref_159 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NodeRemoveParameter + properties: + - collectionFormat: none + constraints: + MaxItems: '100' + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: nodeList + realPath: + - nodeList + serializedName: nodeList + summary: >- + A list containing the IDs of the compute nodes to be removed from the + specified pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default value is 15 minutes. The minimum value is 5 minutes. If + you specify a value less than 5 minutes, the Batch service returns + an error; if you are calling the REST API directly, the HTTP status + code is 400 (Bad Request). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: duration + knownPrimaryType: timeSpan + name: + fixed: false + raw: TimeSpan + name: + fixed: false + raw: resizeTimeout + realPath: + - resizeTimeout + serializedName: resizeTimeout + summary: The timeout for removal of compute nodes to the pool. + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The default value is requeue. + extensions: + x-ms-enum: + modelAsString: false + name: ComputeNodeDeallocationOption + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_126 + name: + fixed: false + raw: nodeDeallocationOption + realPath: + - nodeDeallocationOption + serializedName: nodeDeallocationOption + summary: >- + Determines what to do with a node and its running task(s) after it has + been selected for deallocation. + serializedName: NodeRemoveParameter + summary: Options for removing compute nodes from a pool. +modelsName: Models +name: BatchService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_110 + headers: *ref_130 + isNullable: true + deprecated: false + description: >- + This operation returns only applications and versions that are + available for use on compute nodes; that is, that can be used in an + application package reference. For administrator information about + applications and versions that are not yet available to compute nodes, + use the Azure portal or the Azure Resource Manager API. + extensions: + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: Application + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 applications can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: &ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_131 + headers: *ref_130 + isNullable: true + returnType: + body: *ref_131 + headers: *ref_130 + isNullable: true + serializedName: Application_List + summary: Lists all of the applications available in the specified account. + url: /applications + - defaultResponse: + body: *ref_110 + headers: *ref_132 + isNullable: true + deprecated: false + description: >- + This operation returns only applications and versions that are + available for use on compute nodes; that is, that can be used in an + application package reference. For administrator information about + applications and versions that are not yet available to compute nodes, + use the Azure portal or the Azure Resource Manager API. + extensions: + x-ms-request-id: request-id + group: + fixed: false + raw: Application + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the application. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: applicationId + serializedName: applicationId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_96 + headers: *ref_132 + isNullable: true + returnType: + body: *ref_96 + headers: *ref_132 + isNullable: true + serializedName: Application_Get + summary: Gets information about the specified application. + url: '/applications/{applicationId}' + name: + fixed: false + raw: Application + nameForProperty: Application + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_110 + headers: *ref_134 + isNullable: true + deprecated: false + description: >- + If you do not specify a $filter clause including a poolId, the + response includes all pools that existed in the account in the time + range of the returned aggregation intervals. If you do not specify a + $filter clause including a startTime or endTime these filters default + to the start and end times of the last aggregation interval currently + available; that is, only the last aggregation interval is returned. + extensions: + x-ms-examples: + Pool list usage metrics: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + value: + - dataEgressGiB: '0.00622838735580444' + dataIngressGiB: '0.0692861778661609' + endTime: '2013-04-01T00:30:00Z' + poolId: p1 + startTime: '2013-04-01T00:00:00Z' + totalCoreHours: '39.384838' + vmSize: a1 + - dataEgressGiB: '0.06222838735580444' + dataIngressGiB: '0.6092861778661609' + endTime: '2013-04-01T01:00:00Z' + poolId: p2 + startTime: '2013-04-01T00:30:00Z' + totalCoreHours: '3039.384838' + vmSize: a8 + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: Pool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListUsageMetrics + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The earliest time from which to include metrics. This must be at + least two and a half hours before the current time. If not + specified this defaults to the start time of the last + aggregation interval currently available. + extensions: + x-ms-client-name: startTime + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: starttime + serializedName: starttime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The latest time from which to include metrics. This must be at + least two hours before the current time. If not specified this + defaults to the end time of the last aggregation interval + currently available. + extensions: + x-ms-client-name: endTime + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endtime + serializedName: endtime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 results will be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_135 + headers: *ref_134 + isNullable: true + returnType: + body: *ref_135 + headers: *ref_134 + isNullable: true + serializedName: Pool_ListUsageMetrics + summary: >- + Lists the usage metrics, aggregated by pool across individual time + intervals, for the specified account. + url: /poolusagemetrics + - defaultResponse: + body: *ref_110 + headers: *ref_136 + isNullable: true + deprecated: false + description: >- + Statistics are aggregated across all pools that have ever existed in + the account, from account creation to the last update time of the + statistics. + extensions: + x-ms-examples: + Pool get lifetime statistics: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + lastUpdateTime: '2014-08-04T18:30:00.4345729Z' + resourceStats: + avgCPUPercentage: '40' + avgDiskGiB: '125' + avgMemoryGiB: '2' + diskReadGiB: '10' + diskReadIOps: '0' + diskWriteGiB: '1' + diskWriteIOps: '0' + lastUpdateTime: '2014-08-04T18:30:00.4345729Z' + networkReadGiB: '20' + networkWriteGiB: '25' + peakDiskGiB: '240' + peakMemoryGiB: '4' + startTime: '2014-08-01T18:30:00.4345729Z' + startTime: '2014-08-01T18:30:00.4345729Z' + url: >- + https://account.region.batch.core.windows.net/lifetimepoolstats + usageStats: + dedicatedCoreTime: PT0S + lastUpdateTime: '2014-08-04T18:30:00.4345729Z' + startTime: '2014-08-01T18:30:00.4345729Z' + x-ms-request-id: request-id + group: + fixed: false + raw: Pool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetAllLifetimeStatistics + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_95 + headers: *ref_136 + isNullable: true + returnType: + body: *ref_95 + headers: *ref_136 + isNullable: true + serializedName: Pool_GetAllLifetimeStatistics + summary: >- + Gets lifetime summary statistics for all of the pools in the specified + account. + url: /lifetimepoolstats + - defaultResponse: + body: *ref_110 + headers: *ref_137 + isNullable: true + deprecated: false + description: >- + When naming pools, avoid including sensitive information such as user + names or secret project names. This information may appear in + telemetry logs accessible to Microsoft Support engineers. + extensions: + x-ms-examples: + Add a CloudServiceConfiguration pool: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + pool: + cloudServiceConfiguration: + osFamily: '4' + enableAutoScale: false + enableInterNodeCommunication: true + id: poolId + maxTasksPerNode: '3' + metadata: + - name: myproperty + value: myvalue + resizeTimeout: PT15M + targetDedicatedNodes: '5' + targetLowPriorityNodes: '0' + taskSchedulingPolicy: + nodeFillType: spread + vmSize: small + responses: + '201': + ETag: '0x8D45765A6A2DC04' + Last-Modified: 'Fri, 17 Feb 2017 00:00:00 GMT' + request-id: 00000000-0000-0000-0000-000000000000 + Add a VirtualMachineConfiguration pool: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + pool: + enableAutoScale: false + enableInterNodeCommunication: true + id: pool2 + maxTasksPerNode: '3' + metadata: + - name: myproperty + value: myvalue + resizeTimeout: PT15M + targetDedicatedNodes: '5' + targetLowPriorityNodes: '0' + taskSchedulingPolicy: + nodeFillType: spread + virtualMachineConfiguration: + imageReference: + offer: UbuntuServer + publisher: Canonical + sku: 16.04.0-LTS + nodeAgentSKUId: batch.node.ubuntu 16.04 + vmSize: standard_a1 + responses: + '201': + ETag: '0x8D45765A6A2DC04' + Last-Modified: 'Fri, 17 Feb 2017 00:00:00 GMT' + request-id: 00000000-0000-0000-0000-000000000000 + Add a VirtualMachineConfiguration pool with containers: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + pool: + enableAutoScale: false + id: pool2 + maxTasksPerNode: '3' + resizeTimeout: PT15M + targetDedicatedNodes: '5' + targetLowPriorityNodes: '0' + taskSchedulingPolicy: + nodeFillType: spread + virtualMachineConfiguration: + containerConfiguration: + containerImageNames: + - busybox + type: docker + imageReference: + offer: UbuntuServer + publisher: Canonical + sku: 16.04.0-LTS + nodeAgentSKUId: batch.node.ubuntu 16.04 + vmSize: standard_a1 + responses: + '201': + ETag: '0x8D45765A6A2DC04' + Last-Modified: 'Fri, 17 Feb 2017 00:00:00 GMT' + request-id: 00000000-0000-0000-0000-000000000000 + x-ms-request-id: request-id + x-ms-requestBody-index: '0' + group: + fixed: false + raw: Pool + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Add + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The pool to be added. + extensions: + x-ms-requestBody-name: pool + isConstant: false + isRequired: true + location: body + modelType: *ref_138 + name: + fixed: false + raw: pool + serializedName: pool + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + headers: *ref_137 + isNullable: true + returnType: + headers: *ref_137 + isNullable: true + serializedName: Pool_Add + summary: Adds a pool to the specified account. + url: /pools + - defaultResponse: + body: *ref_110 + headers: *ref_139 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + Pool list: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + value: + - allocationState: steady + allocationStateTransitionTime: '2016-11-21T18:27:40.287803Z' + cloudServiceConfiguration: + currentOSVersion: '*' + osFamily: '4' + targetOSVersion: '*' + creationTime: '2016-11-21T18:26:39.7108787Z' + currentDedicatedNodes: '3' + currentLowPriorityNodes: '0' + eTag: '0x8D4123BEF87D233' + enableAutoScale: false + enableInterNodeCommunication: false + id: testPool + lastModified: '2016-11-21T18:26:39.7108787Z' + maxTasksPerNode: '1' + resizeTimeout: PT15M + startTask: + commandLine: cmd /c echo hello + maxTaskRetryCount: '0' + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + waitForSuccess: false + state: active + stateTransitionTime: '2016-11-21T18:26:39.7108787Z' + targetDedicatedNodes: '3' + targetLowPriorityNodes: '0' + taskSchedulingPolicy: + nodeFillType: spread + url: >- + https://accountname.region.batch.azure.com/pools/testPool + vmSize: small + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: Pool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $expand clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 pools can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_140 + headers: *ref_139 + isNullable: true + returnType: + body: *ref_140 + headers: *ref_139 + isNullable: true + serializedName: Pool_List + summary: Lists all of the pools in the specified account. + url: /pools + - defaultResponse: + body: *ref_110 + headers: *ref_141 + isNullable: true + deprecated: false + description: >- + When you request that a pool be deleted, the following actions occur: + the pool state is set to deleting; any ongoing resize operation on the + pool are stopped; the Batch service starts resizing the pool to zero + nodes; any tasks running on existing nodes are terminated and requeued + (as if a resize pool operation had been requested with the default + requeue option); finally, the pool is removed from the system. Because + running tasks are requeued, the user can rerun these tasks by updating + their job to target a different pool. The tasks can then run on the + new pool. If you want to override the requeue behavior, then you + should call resize pool explicitly to shrink the pool to zero size + before deleting the pool. If you call an Update, Patch or Delete API + on a pool in the deleting state, it will fail with HTTP status code + 409 with error code PoolBeingDeleted. + extensions: + x-ms-examples: + Pool delete: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '202': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: Pool + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_141 + isNullable: true + returnType: + headers: *ref_141 + isNullable: true + serializedName: Pool_Delete + summary: Deletes a pool from the specified account. + url: '/pools/{poolId}' + - defaultResponse: + body: *ref_110 + headers: *ref_142 + isNullable: true + deprecated: false + description: Gets basic properties of a pool. + extensions: + x-ms-request-id: request-id + group: + fixed: false + raw: Pool + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: Exists + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool to get. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + headers: *ref_142 + isNullable: true + OK: + headers: *ref_142 + isNullable: true + returnType: + headers: *ref_142 + isNullable: true + serializedName: Pool_Exists + url: '/pools/{poolId}' + - defaultResponse: + body: *ref_110 + headers: *ref_143 + isNullable: true + deprecated: false + description: Gets information about the specified pool. + extensions: + x-ms-examples: + Pool get: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: pool + responses: + '200': + body: + allocationState: steady + allocationStateTransitionTime: '2016-11-22T18:55:24.8154041Z' + creationTime: '2016-11-22T18:55:24.2632496Z' + currentDedicatedNodes: '0' + currentLowPriorityNodes: '0' + eTag: '0x8D413091E739A56' + enableAutoScale: false + enableInterNodeCommunication: false + id: pool + lastModified: '2016-11-22T18:55:25.2608598Z' + maxTasksPerNode: '1' + resizeTimeout: PT15M + startTask: + commandLine: /bin/bash -c 'echo start task' + maxTaskRetryCount: '0' + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + waitForSuccess: false + state: active + stateTransitionTime: '2016-11-22T18:55:24.2632496Z' + targetDedicatedNodes: '0' + targetLowPriorityNodes: '0' + taskSchedulingPolicy: + nodeFillType: spread + url: 'https://account.region.batch.azure.com/pools/pool' + virtualMachineConfiguration: + imageReference: + offer: UbuntuServer + publisher: Canonical + sku: 16.04.0-LTS + version: latest + nodeAgentSKUId: batch.node.ubuntu 16.04 + vmSize: standard_a1 + x-ms-request-id: request-id + group: + fixed: false + raw: Pool + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool to get. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $expand clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_97 + headers: *ref_143 + isNullable: true + returnType: + body: *ref_97 + headers: *ref_143 + isNullable: true + serializedName: Pool_Get + url: '/pools/{poolId}' + - defaultResponse: + body: *ref_110 + headers: *ref_144 + isNullable: true + deprecated: false + description: >- + This only replaces the pool properties specified in the request. For + example, if the pool has a start task associated with it, and a + request does not specify a start task element, then the pool keeps the + existing start task. + extensions: + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Pool + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: Patch + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool to update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: poolPatchParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_145 + name: + fixed: false + raw: poolPatchParameter + serializedName: poolPatchParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_144 + isNullable: true + returnType: + headers: *ref_144 + isNullable: true + serializedName: Pool_Patch + summary: Updates the properties of the specified pool. + url: '/pools/{poolId}' + - defaultResponse: + body: *ref_110 + headers: *ref_146 + isNullable: true + deprecated: false + extensions: + x-ms-request-id: request-id + group: + fixed: false + raw: Pool + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: DisableAutoScale + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool on which to disable automatic scaling. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_146 + isNullable: true + returnType: + headers: *ref_146 + isNullable: true + serializedName: Pool_DisableAutoScale + summary: Disables automatic scaling for a pool. + url: '/pools/{poolId}/disableautoscale' + - defaultResponse: + body: *ref_110 + headers: *ref_147 + isNullable: true + deprecated: false + description: >- + You cannot enable automatic scaling on a pool if a resize operation is + in progress on the pool. If automatic scaling of the pool is currently + disabled, you must specify a valid autoscale formula as part of the + request. If automatic scaling of the pool is already enabled, you may + specify a new autoscale formula and/or a new evaluation interval. You + cannot call this API for the same pool more than once every 30 + seconds. + extensions: + x-ms-examples: + Pool enable autoscale: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolEnableAutoScaleParameter: + autoScaleEvaluationInterval: PT8M + autoScaleFormula: $TargetDedicated=0 + poolId: poolId + responses: + '200': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Pool + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: EnableAutoScale + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool on which to enable automatic scaling. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: poolEnableAutoScaleParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_148 + name: + fixed: false + raw: poolEnableAutoScaleParameter + serializedName: poolEnableAutoScaleParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_147 + isNullable: true + returnType: + headers: *ref_147 + isNullable: true + serializedName: Pool_EnableAutoScale + summary: Enables automatic scaling for a pool. + url: '/pools/{poolId}/enableautoscale' + - defaultResponse: + body: *ref_110 + headers: *ref_149 + isNullable: true + deprecated: false + description: >- + This API is primarily for validating an autoscale formula, as it + simply returns the result without applying the formula to the pool. + The pool must have auto scaling enabled in order to evaluate a + formula. + extensions: + x-ms-examples: + Pool evaluate autoscale: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolEvaluateAutoScaleParameter: + autoScaleFormula: $TargetDedicated=1 + poolId: poolId + responses: + '200': + body: + results: $TargetDedicated=1;$NodeDeallocationOption=requeue + timestamp: '2016-11-22T19:39:28.5246331Z' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Pool + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: EvaluateAutoScale + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the pool on which to evaluate the automatic scaling + formula. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: poolEvaluateAutoScaleParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_150 + name: + fixed: false + raw: poolEvaluateAutoScaleParameter + serializedName: poolEvaluateAutoScaleParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_94 + headers: *ref_149 + isNullable: true + returnType: + body: *ref_94 + headers: *ref_149 + isNullable: true + serializedName: Pool_EvaluateAutoScale + summary: >- + Gets the result of evaluating an automatic scaling formula on the + pool. + url: '/pools/{poolId}/evaluateautoscale' + - defaultResponse: + body: *ref_110 + headers: *ref_151 + isNullable: true + deprecated: false + description: >- + You can only resize a pool when its allocation state is steady. If the + pool is already resizing, the request fails with status code 409. When + you resize a pool, the pool's allocation state changes from steady to + resizing. You cannot resize pools which are configured for automatic + scaling. If you try to do this, the Batch service returns an error + 409. If you resize a pool downwards, the Batch service chooses which + nodes to remove. To remove specific nodes, use the pool remove nodes + API instead. + extensions: + x-ms-examples: + Pool resize: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: resizePool + poolResizeParameter: + targetDedicatedNodes: '1' + targetLowPriorityNodes: '0' + responses: + '202': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Pool + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Resize + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool to resize. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: poolResizeParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_152 + name: + fixed: false + raw: poolResizeParameter + serializedName: poolResizeParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_151 + isNullable: true + returnType: + headers: *ref_151 + isNullable: true + serializedName: Pool_Resize + summary: Changes the number of compute nodes that are assigned to a pool. + url: '/pools/{poolId}/resize' + - defaultResponse: + body: *ref_110 + headers: *ref_153 + isNullable: true + deprecated: false + description: >- + This does not restore the pool to its previous state before the resize + operation: it only stops any further changes being made, and the pool + maintains its current state. After stopping, the pool stabilizes at + the number of nodes it was at when the stop operation was done. During + the stop operation, the pool allocation state changes first to + stopping and then to steady. A resize operation need not be an + explicit resize pool request; this API can also be used to halt the + initial sizing of the pool when it is created. + extensions: + x-ms-examples: + Pool stop resize: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '202': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: Pool + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StopResize + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool whose resizing you want to stop. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_153 + isNullable: true + returnType: + headers: *ref_153 + isNullable: true + serializedName: Pool_StopResize + summary: Stops an ongoing resize operation on the pool. + url: '/pools/{poolId}/stopresize' + - defaultResponse: + body: *ref_110 + headers: *ref_154 + isNullable: true + deprecated: false + description: >- + This fully replaces all the updateable properties of the pool. For + example, if the pool has a start task associated with it and if start + task is not specified with this request, then the Batch service will + remove the existing start task. + extensions: + x-ms-examples: + Pool update: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + poolUpdatePropertiesParameter: + applicationPackageReferences: [] + certificateReferences: [] + metadata: [] + startTask: + commandLine: /bin/bash -c 'echo start task' + responses: + '204': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Pool + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateProperties + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool to update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: poolUpdatePropertiesParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_155 + name: + fixed: false + raw: poolUpdatePropertiesParameter + serializedName: poolUpdatePropertiesParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + headers: *ref_154 + isNullable: true + returnType: + headers: *ref_154 + isNullable: true + serializedName: Pool_UpdateProperties + summary: Updates the properties of the specified pool. + url: '/pools/{poolId}/updateproperties' + - defaultResponse: + body: *ref_110 + headers: *ref_156 + isNullable: true + deprecated: false + description: >- + During an upgrade, the Batch service upgrades each compute node in the + pool. When a compute node is chosen for upgrade, any tasks running on + that node are removed from the node and returned to the queue to be + rerun later (or on a different compute node). The node will be + unavailable until the upgrade is complete. This operation results in + temporarily reduced pool capacity as nodes are taken out of service to + be upgraded. Although the Batch service tries to avoid upgrading all + compute nodes at the same time, it does not guarantee to do this + (particularly on small pools); therefore, the pool may be temporarily + unavailable to run tasks. When this operation runs, the pool state + changes to upgrading. When all compute nodes have finished upgrading, + the pool state returns to active. While the upgrade is in progress, + the pool's currentOSVersion reflects the OS version that nodes are + upgrading from, and targetOSVersion reflects the OS version that nodes + are upgrading to. Once the upgrade is complete, currentOSVersion is + updated to reflect the OS version now running on all nodes. This + operation can only be invoked on pools created with the + cloudServiceConfiguration property. + extensions: + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Pool + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: UpgradeOS + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool to upgrade. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: poolUpgradeOSParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_157 + name: + fixed: false + raw: poolUpgradeOSParameter + serializedName: poolUpgradeOSParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_156 + isNullable: true + returnType: + headers: *ref_156 + isNullable: true + serializedName: Pool_UpgradeOS + summary: Upgrades the operating system of the specified pool. + url: '/pools/{poolId}/upgradeos' + - defaultResponse: + body: *ref_110 + headers: *ref_158 + isNullable: true + deprecated: false + description: >- + This operation can only run when the allocation state of the pool is + steady. When this operation runs, the allocation state changes from + steady to resizing. + extensions: + x-ms-examples: + Pool remove nodes: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeRemoveParameter: + nodeList: + - tvm-1695681911_1-20161122t224741z + - tvm-1695681911_2-20161122t224741z + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '202': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Pool + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: RemoveNodes + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool from which you want to remove nodes. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: nodeRemoveParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_159 + name: + fixed: false + raw: nodeRemoveParameter + serializedName: nodeRemoveParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_158 + isNullable: true + returnType: + headers: *ref_158 + isNullable: true + serializedName: Pool_RemoveNodes + summary: Removes compute nodes from the specified pool. + url: '/pools/{poolId}/removenodes' + name: + fixed: false + raw: Pool + nameForProperty: Pool + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_110 + headers: *ref_160 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + Account list node agent skus: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + value: + - id: batch.node.centos 7 + osType: linux + verifiedImageReferences: + - offer: CentOS + publisher: OpenLogic + sku: '7.2' + version: latest + - offer: CentOS + publisher: OpenLogic + sku: '7.1' + version: latest + - id: batch.node.debian 8 + osType: linux + verifiedImageReferences: + - offer: Debian + publisher: Credativ + sku: '8' + version: latest + - id: batch.node.windows amd64 + osType: windows + verifiedImageReferences: + - offer: WindowsServer + publisher: MicrosoftWindowsServer + sku: 2012-R2-Datacenter + version: latest + - offer: WindowsServer + publisher: MicrosoftWindowsServer + sku: 2012-Datacenter + version: latest + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: Account + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListNodeAgentSkus + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 results will be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_161 + headers: *ref_160 + isNullable: true + returnType: + body: *ref_161 + headers: *ref_160 + isNullable: true + serializedName: Account_ListNodeAgentSkus + summary: Lists all node agent SKUs supported by the Azure Batch service. + url: /nodeagentskus + name: + fixed: false + raw: Account + nameForProperty: Account + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_110 + headers: *ref_162 + isNullable: true + deprecated: false + description: >- + Statistics are aggregated across all jobs that have ever existed in + the account, from account creation to the last update time of the + statistics. + extensions: + x-ms-examples: + Job get lifetime statistics: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + kernelCPUTime: PT0S + lastUpdateTime: '2014-08-04T18:30:00.4345729Z' + numFailedTasks: '0' + numSucceededTasks: '0' + numTaskRetries: '0' + readIOGiB: '10' + readIOps: '0' + startTime: '2014-08-01T18:30:00.4345729Z' + url: >- + https://account.region.batch.core.windows.net/lifetimejobstats + userCPUTime: PT0S + waitTime: PT0S + wallClockTime: PT0S + writeIOGiB: '5' + writeIOps: '0' + x-ms-request-id: request-id + group: + fixed: false + raw: Job + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetAllLifetimeStatistics + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_79 + headers: *ref_162 + isNullable: true + returnType: + body: *ref_79 + headers: *ref_162 + isNullable: true + serializedName: Job_GetAllLifetimeStatistics + summary: >- + Gets lifetime summary statistics for all of the jobs in the specified + account. + url: /lifetimejobstats + - defaultResponse: + body: *ref_110 + headers: *ref_163 + isNullable: true + deprecated: false + description: >- + Deleting a job also deletes all tasks that are part of that job, and + all job statistics. This also overrides the retention period for task + data; that is, if the job contains tasks which are still retained on + compute nodes, the Batch services deletes those tasks' working + directories and all their contents. When a Delete Job request is + received, the Batch service sets the job to the deleting state. All + update operations on a job that is in deleting state will fail with + status code 409 (Conflict), with additional information indicating + that the job is being deleted. + extensions: + x-ms-request-id: request-id + group: + fixed: false + raw: Job + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_163 + isNullable: true + returnType: + headers: *ref_163 + isNullable: true + serializedName: Job_Delete + summary: Deletes a job. + url: '/jobs/{jobId}' + - defaultResponse: + body: *ref_110 + headers: *ref_164 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + Job get: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: P10675199DT2H48M5.4775807S + creationTime: '2016-11-19T00:05:25.311915Z' + eTag: '0x8D4100FC49F0278' + executionInfo: + endTime: '2016-11-19T00:05:27.578581Z' + poolId: poolId + startTime: '2016-11-19T00:05:25.3309105Z' + terminateReason: UserTerminate + id: jobId + lastModified: '2016-11-19T00:05:27.5391608Z' + onAllTasksComplete: noAction + onTaskFailure: noAction + poolInfo: + poolId: poolId + previousState: active + previousStateTransitionTime: '2016-11-19T00:05:27.2137716Z' + priority: '0' + state: completed + stateTransitionTime: '2016-11-19T00:05:27.578581Z' + url: 'https://account.region.batch.azure.com/jobs/jobId' + usesTaskDependencies: false + x-ms-request-id: request-id + group: + fixed: false + raw: Job + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $expand clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_80 + headers: *ref_164 + isNullable: true + returnType: + body: *ref_80 + headers: *ref_164 + isNullable: true + serializedName: Job_Get + summary: Gets information about the specified job. + url: '/jobs/{jobId}' + - defaultResponse: + body: *ref_110 + headers: *ref_165 + isNullable: true + deprecated: false + description: >- + This replaces only the job properties specified in the request. For + example, if the job has constraints, and a request does not specify + the constraints element, then the job keeps the existing constraints. + extensions: + x-ms-examples: + Job patch: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + jobPatchParameter: + constraints: + maxTaskRetryCount: '-1' + maxWallClockTime: PT1H + poolInfo: + poolId: poolId + priority: '100' + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Job + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: Patch + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job whose properties you want to update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: jobPatchParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_166 + name: + fixed: false + raw: jobPatchParameter + serializedName: jobPatchParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_165 + isNullable: true + returnType: + headers: *ref_165 + isNullable: true + serializedName: Job_Patch + summary: Updates the properties of the specified job. + url: '/jobs/{jobId}' + - defaultResponse: + body: *ref_110 + headers: *ref_167 + isNullable: true + deprecated: false + description: >- + This fully replaces all the updateable properties of the job. For + example, if the job has constraints associated with it and if + constraints is not specified with this request, then the Batch service + will remove the existing constraints. + extensions: + x-ms-examples: + Job update: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + jobUpdateParameter: + constraints: + maxTaskRetryCount: '-1' + maxWallClockTime: PT1H + poolInfo: + poolId: poolId + priority: '100' + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Job + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: Update + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job whose properties you want to update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: jobUpdateParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_168 + name: + fixed: false + raw: jobUpdateParameter + serializedName: jobUpdateParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_167 + isNullable: true + returnType: + headers: *ref_167 + isNullable: true + serializedName: Job_Update + summary: Updates the properties of the specified job. + url: '/jobs/{jobId}' + - defaultResponse: + body: *ref_110 + headers: *ref_169 + isNullable: true + deprecated: false + description: >- + The Batch Service immediately moves the job to the disabling state. + Batch then uses the disableTasks parameter to determine what to do + with the currently running tasks of the job. The job remains in the + disabling state until the disable operation is completed and all tasks + have been dealt with according to the disableTasks option; the job + then moves to the disabled state. No new tasks are started under the + job until it moves back to active state. If you try to disable a job + that is in any state other than active, disabling, or disabled, the + request fails with status code 409. + extensions: + x-ms-examples: + Job disable: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobDisableParameter: + disableTasks: terminate + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '202': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Job + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Disable + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job to disable. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: jobDisableParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_170 + name: + fixed: false + raw: jobDisableParameter + serializedName: jobDisableParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_169 + isNullable: true + returnType: + headers: *ref_169 + isNullable: true + serializedName: Job_Disable + summary: 'Disables the specified job, preventing new tasks from running.' + url: '/jobs/{jobId}/disable' + - defaultResponse: + body: *ref_110 + headers: *ref_171 + isNullable: true + deprecated: false + description: >- + When you call this API, the Batch service sets a disabled job to the + enabling state. After the this operation is completed, the job moves + to the active state, and scheduling of new tasks under the job + resumes. The Batch service does not allow a task to remain in the + active state for more than 7 days. Therefore, if you enable a job + containing active tasks which were added more than 7 days ago, those + tasks will not run. + extensions: + x-ms-examples: + Job enable: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '202': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: Job + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Enable + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job to enable. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_171 + isNullable: true + returnType: + headers: *ref_171 + isNullable: true + serializedName: Job_Enable + summary: 'Enables the specified job, allowing new tasks to run.' + url: '/jobs/{jobId}/enable' + - defaultResponse: + body: *ref_110 + headers: *ref_172 + isNullable: true + deprecated: false + description: >- + When a Terminate Job request is received, the Batch service sets the + job to the terminating state. The Batch service then terminates any + active or running tasks associated with the job, and runs any required + Job Release tasks. The job then moves into the completed state. + extensions: + x-ms-examples: + Job terminate: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + jobTerminateParameter: + terminateReason: User supplied termination reason + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '202': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Job + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Terminate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job to terminate. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: jobTerminateParameter + isConstant: false + isRequired: false + location: body + modelType: *ref_173 + name: + fixed: false + raw: jobTerminateParameter + serializedName: jobTerminateParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_172 + isNullable: true + returnType: + headers: *ref_172 + isNullable: true + serializedName: Job_Terminate + summary: 'Terminates the specified job, marking it as completed.' + url: '/jobs/{jobId}/terminate' + - defaultResponse: + body: *ref_110 + headers: *ref_174 + isNullable: true + deprecated: false + description: >- + The Batch service supports two ways to control the work done as part + of a job. In the first approach, the user specifies a Job Manager + task. The Batch service launches this task when it is ready to start + the job. The Job Manager task controls all other tasks that run under + this job, by using the Task APIs. In the second approach, the user + directly controls the execution of tasks under an active job, by using + the Task APIs. Also note: when naming jobs, avoid including sensitive + information such as user names or secret project names. This + information may appear in telemetry logs accessible to Microsoft + Support engineers. + extensions: + x-ms-examples: + Add a basic job: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + job: + id: jobId + poolInfo: + poolId: poolId + priority: '0' + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '201': + body: '' + Add a complex job: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + job: + constraints: + maxTaskRetryCount: '-1' + maxWallClockTime: PT1H + id: jobId + jobManagerTask: + commandLine: myprogram.exe + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: PT1H + retentionTime: PT1H + environmentSettings: + - name: myvariable + value: myvalue + id: taskId + killJobOnCompletion: false + resourceFiles: + - blobSource: >- + http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?st=2013-08-09T08%3a49%3a37.0000000Z&se=2013-08-10T08%3a49%3a37.0000000Z&sr=c&sp=d&si=YWJjZGTVMZw%3d%3d&sig=%2bSzBm0wi8xECuGkKw97wnkSZ%2f62sxU%2b6Hq6a7qojIVE%3d + filePath: myprogram.exe + - blobSource: >- + http://mystorage1.blob.core.windows.net/scripts/test.txt?st=2013-08-09T08%3a49%3a37.0000000Z&se=2013-08-10T08%3a49%3a37.0000000Z&sr=c&sp=d&si=YWJjZGTVMZw%3d%3d&sig=%2bSzBm0wi8xECuGkKw97wnkSZ%2f62sxU%2b6Hq6a7qojIVE%3d + filePath: test.txt + runExclusive: true + userIdentity: + autoUser: + elevationLevel: admin + scope: task + metadata: + - name: myproperty + value: myvalue + poolInfo: + autoPoolSpecification: + autoPoolIdPrefix: mypool + pool: + certificateReferences: + - storeLocation: localMachine + storeName: Root + thumbprint: 0123456789abcdef0123456789abcdef01234567 + thumbprintAlgorithm: sha1 + visibility: + - task + cloudServiceConfiguration: + osFamily: '4' + targetOSVersion: '*' + enableAutoScale: false + enableInterNodeCommunication: true + maxTasksPerNode: '2' + metadata: + - name: myproperty + value: myvalue + resizeTimeout: PT15M + startTask: + commandLine: myprogram2.exe + environmentSettings: + - name: myvariable + value: myvalue + maxTaskRetryCount: '2' + resourceFiles: + - blobSource: >- + http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?st=2013-08-09T08%3a49%3a37.0000000Z&se=2013-08-10T08%3a49%3a37.0000000Z&sr=c&sp=d&si=YWJjZGTVMZw%3d%3d&sig= + %2bSzBm0wi8xECuGkKw97wnkSZ%2f62sxU%2b6Hq6a7qojIVE%3d + filePath: myprogram2.exe + userIdentity: + autoUser: + elevationLevel: admin + scope: task + waitForSuccess: true + targetDedicatedNodes: '3' + targetLowPriorityNodes: '0' + taskSchedulingPolicy: + nodeFillType: spread + vmSize: small + poolLifetimeOption: job + priority: '100' + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '201': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '0' + group: + fixed: false + raw: Job + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Add + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The job to be added. + extensions: + x-ms-requestBody-name: job + isConstant: false + isRequired: true + location: body + modelType: *ref_175 + name: + fixed: false + raw: job + serializedName: job + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + headers: *ref_174 + isNullable: true + returnType: + headers: *ref_174 + isNullable: true + serializedName: Job_Add + summary: Adds a job to the specified account. + url: /jobs + - defaultResponse: + body: *ref_110 + headers: *ref_176 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + Job list: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + value: + - constraints: + maxTaskRetryCount: '0' + maxWallClockTime: P10675199DT2H48M5.4775807S + creationTime: '2016-11-19T00:05:25.311915Z' + eTag: '0x8D4100FC46D5BF4' + executionInfo: + poolId: poolId + startTime: '2016-11-19T00:05:25.3309105Z' + id: jobId + lastModified: '2016-11-19T00:05:27.2137716Z' + onAllTasksComplete: noAction + onTaskFailure: noAction + poolInfo: + poolId: poolId + previousState: disabled + previousStateTransitionTime: '2016-11-19T00:05:26.88777Z' + priority: '0' + state: active + stateTransitionTime: '2016-11-19T00:05:27.2137716Z' + url: 'https://account.region.batch.azure.com/jobs/jobId' + usesTaskDependencies: false + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: Job + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $expand clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 jobs can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_177 + headers: *ref_176 + isNullable: true + returnType: + body: *ref_177 + headers: *ref_176 + isNullable: true + serializedName: Job_List + summary: Lists all of the jobs in the specified account. + url: /jobs + - defaultResponse: + body: *ref_110 + headers: *ref_178 + isNullable: true + deprecated: false + extensions: + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: Job + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListFromJobSchedule + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the job schedule from which you want to get a list of + jobs. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobScheduleId + serializedName: jobScheduleId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $expand clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 jobs can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_177 + headers: *ref_178 + isNullable: true + returnType: + body: *ref_177 + headers: *ref_178 + isNullable: true + serializedName: Job_ListFromJobSchedule + summary: >- + Lists the jobs that have been created under the specified job + schedule. + url: '/jobschedules/{jobScheduleId}/jobs' + - defaultResponse: + body: *ref_110 + headers: *ref_179 + isNullable: true + deprecated: false + description: >- + This API returns the Job Preparation and Job Release task status on + all compute nodes that have run the Job Preparation or Job Release + task. This includes nodes which have since been removed from the pool. + If this API is invoked on a job which has no Job Preparation or Job + Release task, the Batch service returns HTTP status code 409 + (Conflict) with an error code of JobPreparationTaskNotSpecified. + extensions: + x-ms-examples: + Job list preparation and release task status: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + odata.nextLink: >- + https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2017-09-01.6.0 + value: + - jobPreparationTaskExecutionInfo: + endTime: '2015-05-02T20:12:42Z' + exitCode: '0' + retryCount: '0' + startTime: '2015-05-01T10:20:31Z' + state: completed + taskRootDirectory: tasks/myjob/job-1/myjobpreptask + taskRootDirectoryUrl: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask + jobReleaseTaskExecutionInfo: + endTime: '2015-05-02T20:12:42Z' + exitCode: '0' + startTime: '2015-05-01T10:20:31Z' + state: completed + taskRootDirectory: tasks/myjob/job-1/myjobreleasetask + taskRootDirectoryUrl: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask + nodeId: tvm-2167304207_1-20140905t174658z + nodeUrl: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z + poolId: poolId + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: Job + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListPreparationAndReleaseTaskStatus + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 tasks can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_180 + headers: *ref_179 + isNullable: true + returnType: + body: *ref_180 + headers: *ref_179 + isNullable: true + serializedName: Job_ListPreparationAndReleaseTaskStatus + summary: >- + Lists the execution status of the Job Preparation and Job Release task + for the specified job across the compute nodes where the job has run. + url: '/jobs/{jobId}/jobpreparationandreleasetaskstatus' + - defaultResponse: + body: *ref_110 + headers: *ref_181 + isNullable: true + deprecated: false + description: >- + Task counts provide a count of the tasks by active, running or + completed task state, and a count of tasks which succeeded or failed. + Tasks in the preparing state are counted as running. If the + validationStatus is unvalidated, then the Batch service has not been + able to check state counts against the task states as reported in the + List Tasks API. The validationStatus may be unvalidated if the job + contains more than 200,000 tasks. + extensions: + x-ms-examples: + Job get task counts: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + active: '5' + completed: '4' + failed: '2' + running: '7' + succeeded: '2' + validationStatus: unvalidated + x-ms-request-id: request-id + group: + fixed: false + raw: Job + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetTaskCounts + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_182 + headers: *ref_181 + isNullable: true + returnType: + body: *ref_182 + headers: *ref_181 + isNullable: true + serializedName: Job_GetTaskCounts + summary: Gets the task counts for the specified job. + url: '/jobs/{jobId}/taskcounts' + name: + fixed: false + raw: Job + nameForProperty: Job + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_110 + headers: *ref_183 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + Certificate add: + parameters: + api-version: 2017-09-01.6.0 + certificate: + certificateFormat: pfx + data: '#####...' + password: certpassword + thumbprint: 0123456789abcdef0123456789abcdef01234567 + thumbprintAlgorithm: sha1 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '201': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '0' + group: + fixed: false + raw: Certificate + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Add + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The certificate to be added. + extensions: + x-ms-requestBody-name: certificate + isConstant: false + isRequired: true + location: body + modelType: *ref_184 + name: + fixed: false + raw: certificate + serializedName: certificate + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + headers: *ref_183 + isNullable: true + returnType: + headers: *ref_183 + isNullable: true + serializedName: Certificate_Add + summary: Adds a certificate to the specified account. + url: /certificates + - defaultResponse: + body: *ref_110 + headers: *ref_185 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + Certificate list: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + value: + - deleteCertificateError: + code: PoolsReferencingCertificate + message: >- + The specified certificate is being used by the below + mentioned pool(s) + values: + - name: Pools + value: mypool1 + previousState: deleting + previousStateTransitionTime: '2014-07-31T21:11:58.236Z' + publicData: '#####...' + state: deleteFailed + stateTransitionTime: '2014-07-31T21:12:58.236Z' + thumbprint: 0123456789abcdef0123456789abcdef01234567 + thumbprintAlgorithm: sha1 + url: >- + https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567) + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: Certificate + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 certificates can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_186 + headers: *ref_185 + isNullable: true + returnType: + body: *ref_186 + headers: *ref_185 + isNullable: true + serializedName: Certificate_List + summary: >- + Lists all of the certificates that have been added to the specified + account. + url: /certificates + - defaultResponse: + body: *ref_110 + headers: *ref_187 + isNullable: true + deprecated: false + description: >- + If you try to delete a certificate that is being used by a pool or + compute node, the status of the certificate changes to deleteFailed. + If you decide that you want to continue using the certificate, you can + use this operation to set the status of the certificate back to + active. If you intend to delete the certificate, you do not need to + run this operation after the deletion failed. You must make sure that + the certificate is not being used by any resources, and then you can + try again to delete the certificate. + extensions: + x-ms-examples: + Certificate cancel delete: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + thumbprint: 0123456789abcdef0123456789abcdef01234567 + thumbprintAlgorithm: sha1 + responses: + '204': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: Certificate + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CancelDeletion + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The algorithm used to derive the thumbprint parameter. This must + be sha1. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprintAlgorithm + serializedName: thumbprintAlgorithm + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The thumbprint of the certificate being deleted. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprint + serializedName: thumbprint + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + headers: *ref_187 + isNullable: true + returnType: + headers: *ref_187 + isNullable: true + serializedName: Certificate_CancelDeletion + summary: Cancels a failed deletion of a certificate from the specified account. + url: >- + /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete + - defaultResponse: + body: *ref_110 + headers: *ref_188 + isNullable: true + deprecated: false + description: >- + You cannot delete a certificate if a resource (pool or compute node) + is using it. Before you can delete a certificate, you must therefore + make sure that the certificate is not associated with any existing + pools, the certificate is not installed on any compute nodes (even if + you remove a certificate from a pool, it is not removed from existing + compute nodes in that pool until they restart), and no running tasks + depend on the certificate. If you try to delete a certificate that is + in use, the deletion fails. The certificate status changes to + deleteFailed. You can use Cancel Delete Certificate to set the status + back to active if you decide that you want to continue using the + certificate. + extensions: + x-ms-examples: + Certificate delete: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + thumbprint: 0123456789abcdef0123456789abcdef01234567 + thumbprintAlgorithm: sha1 + responses: + '202': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: Certificate + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The algorithm used to derive the thumbprint parameter. This must + be sha1. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprintAlgorithm + serializedName: thumbprintAlgorithm + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The thumbprint of the certificate to be deleted. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprint + serializedName: thumbprint + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_188 + isNullable: true + returnType: + headers: *ref_188 + isNullable: true + serializedName: Certificate_Delete + summary: Deletes a certificate from the specified account. + url: >- + /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}) + - defaultResponse: + body: *ref_110 + headers: *ref_189 + isNullable: true + deprecated: false + description: Gets information about the specified certificate. + extensions: + x-ms-examples: + Certificate get: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + thumbprint: 0123456789abcdef0123456789abcdef01234567 + thumbprintAlgorithm: sha1 + responses: + '200': + body: + deleteCertificateError: + code: PoolsReferencingCertificate + message: >- + The specified certificate is being used by the below + mentioned pool(s) + values: + - name: Pools + value: mypool1 + previousState: deleting + previousStateTransitionTime: '2014-07-31T21:11:58.236Z' + publicData: '#####...' + state: deleteFailed + stateTransitionTime: '2014-07-31T21:12:58.236Z' + thumbprint: 0123456789abcdef0123456789abcdef01234567 + thumbprintAlgorithm: sha1 + url: >- + https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567) + x-ms-request-id: request-id + group: + fixed: false + raw: Certificate + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The algorithm used to derive the thumbprint parameter. This must + be sha1. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprintAlgorithm + serializedName: thumbprintAlgorithm + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The thumbprint of the certificate to get. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprint + serializedName: thumbprint + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_11 + headers: *ref_189 + isNullable: true + returnType: + body: *ref_11 + headers: *ref_189 + isNullable: true + serializedName: Certificate_Get + url: >- + /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}) + name: + fixed: false + raw: Certificate + nameForProperty: Certificate + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_110 + headers: *ref_190 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + File delete from task: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + filePath: wd\testFile.txt + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + recursive: 'false' + taskId: task1 + responses: + '200': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: File + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteFromTask + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job that contains the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task whose file you want to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The path to the task file or directory that you want to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filePath + serializedName: filePath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Whether to delete children of a directory. If the filePath + parameter represents a directory instead of a file, you can set + recursive to true to delete the directory and all of the files + and subdirectories in it. If recursive is false then the + directory must be empty or deletion will fail. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: recursive + serializedName: recursive + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_190 + isNullable: true + returnType: + headers: *ref_190 + isNullable: true + serializedName: File_DeleteFromTask + summary: >- + Deletes the specified task file from the compute node where the task + ran. + url: '/jobs/{jobId}/tasks/{taskId}/files/{filePath}' + - defaultResponse: + body: *ref_110 + headers: *ref_191 + isNullable: true + deprecated: false + description: Returns the content of the specified task file. + extensions: + x-ms-request-id: request-id + group: + fixed: false + raw: File + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetFromTask + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job that contains the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task whose file you want to retrieve. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The path to the task file that you want to get the content of. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filePath + serializedName: filePath + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The byte range to be retrieved. The default is to retrieve the + entire file. The format is bytes=startRange-endRange. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-range + serializedName: ocp-range + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_192 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + headers: *ref_191 + isNullable: true + returnType: + body: *ref_192 + headers: *ref_191 + isNullable: true + serializedName: File_GetFromTask + url: '/jobs/{jobId}/tasks/{taskId}/files/{filePath}' + - defaultResponse: + body: *ref_110 + headers: *ref_193 + isNullable: true + deprecated: false + description: Gets the properties of the specified task file. + extensions: + x-ms-examples: + File get properties from task: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + filePath: wd\testFile.txt + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + taskId: taskId + responses: + '200': + Content-Length: '17' + Content-Type: application/octet-stream + Last-Modified: 'Fri, 17 Feb 2017 00:00:00 GMT' + body: '' + ocp-batch-file-isdirectory: 'false' + ocp-creation-time: 'Fri, 17 Feb 2017 00:00:00 GMT' + x-ms-request-id: request-id + group: + fixed: false + raw: File + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: GetPropertiesFromTask + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job that contains the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task whose file you want to get the properties of. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The path to the task file that you want to get the properties + of. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filePath + serializedName: filePath + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_193 + isNullable: true + returnType: + headers: *ref_193 + isNullable: true + serializedName: File_GetPropertiesFromTask + url: '/jobs/{jobId}/tasks/{taskId}/files/{filePath}' + - defaultResponse: + body: *ref_110 + headers: *ref_194 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + File delete from node: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + filePath: workitems\jobId\job-1\task1\wd\testFile.txt + nodeId: tvm-1695681911_1-20161122t193202z + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + recursive: 'false' + responses: + '200': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: File + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteFromComputeNode + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the compute node from which you want to delete the + file. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The path to the file or directory that you want to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filePath + serializedName: filePath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Whether to delete children of a directory. If the filePath + parameter represents a directory instead of a file, you can set + recursive to true to delete the directory and all of the files + and subdirectories in it. If recursive is false then the + directory must be empty or deletion will fail. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: recursive + serializedName: recursive + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_194 + isNullable: true + returnType: + headers: *ref_194 + isNullable: true + serializedName: File_DeleteFromComputeNode + summary: Deletes the specified file from the compute node. + url: '/pools/{poolId}/nodes/{nodeId}/files/{filePath}' + - defaultResponse: + body: *ref_110 + headers: *ref_195 + isNullable: true + deprecated: false + description: Returns the content of the specified compute node file. + extensions: + x-ms-request-id: request-id + group: + fixed: false + raw: File + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetFromComputeNode + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the compute node that contains the file. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The path to the compute node file that you want to get the + content of. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filePath + serializedName: filePath + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The byte range to be retrieved. The default is to retrieve the + entire file. The format is bytes=startRange-endRange. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ocp-range + serializedName: ocp-range + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_196 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + headers: *ref_195 + isNullable: true + returnType: + body: *ref_196 + headers: *ref_195 + isNullable: true + serializedName: File_GetFromComputeNode + url: '/pools/{poolId}/nodes/{nodeId}/files/{filePath}' + - defaultResponse: + body: *ref_110 + headers: *ref_197 + isNullable: true + deprecated: false + description: Gets the properties of the specified compute node file. + extensions: + x-ms-examples: + File get properties from node: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + filePath: workitems\jobId\job-1\task1\wd\testFile.txt + nodeId: nodeId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '200': + Content-Length: '17' + Content-Type: application/octet-stream + Last-Modified: 'Fri, 17 Feb 2017 00:00:00 GMT' + body: '' + ocp-batch-file-isdirectory: 'false' + ocp-creation-time: 'Fri, 17 Feb 2017 00:00:00 GMT' + x-ms-request-id: request-id + group: + fixed: false + raw: File + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: GetPropertiesFromComputeNode + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the compute node that contains the file. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The path to the compute node file that you want to get the + properties of. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filePath + serializedName: filePath + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_197 + isNullable: true + returnType: + headers: *ref_197 + isNullable: true + serializedName: File_GetPropertiesFromComputeNode + url: '/pools/{poolId}/nodes/{nodeId}/files/{filePath}' + - defaultResponse: + body: *ref_110 + headers: *ref_198 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + File list from task: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + recursive: 'false' + taskId: taskId + responses: + '200': + body: + value: + - isDirectory: false + name: startup\ProcessEnv.cmd + properties: + contentLength: '1813' + contentType: application/octet-stream + creationTime: '2014-09-19T21:56:17.679195Z' + lastModified: '2014-09-19T21:56:17.679195Z' + url: >- + https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\ProcessEnv.cmd + - isDirectory: false + name: startup\stderr.txt + properties: + contentLength: '0' + contentType: application/octet-stream + creationTime: '2014-09-19T21:56:17.5590855Z' + lastModified: '2014-09-19T21:56:17.5590855Z' + url: >- + https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\stderr.txt + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: File + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListFromTask + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job that contains the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task whose files you want to list. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Whether to list children of the task directory. This parameter + can be used in combination with the filter parameter to list + specific type of files. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: recursive + serializedName: recursive + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 files can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_199 + headers: *ref_198 + isNullable: true + returnType: + body: *ref_199 + headers: *ref_198 + isNullable: true + serializedName: File_ListFromTask + summary: Lists the files in a task's directory on its compute node. + url: '/jobs/{jobId}/tasks/{taskId}/files' + - defaultResponse: + body: *ref_110 + headers: *ref_200 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + File list from node: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeId: tvm-1695681911_1-20161122t193202z + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + recursive: 'false' + responses: + '200': + body: + value: + - isDirectory: true + name: shared + url: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared + - isDirectory: false + name: startup\ProcessEnv.cmd + properties: + contentLength: '1813' + contentType: application/octet-stream + creationTime: '2014-09-19T21:56:17.679195Z' + lastModified: '2014-09-19T21:56:17.679195Z' + url: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\ProcessEnv.cmd + - isDirectory: false + name: startup\stderr.txt + properties: + contentLength: '0' + contentType: application/octet-stream + creationTime: '2014-09-19T21:56:17.5590855Z' + lastModified: '2014-09-19T21:56:17.5590855Z' + url: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\stderr.txt + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: File + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListFromComputeNode + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the compute node whose files you want to list. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Whether to list children of a directory. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: recursive + serializedName: recursive + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 files can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_199 + headers: *ref_200 + isNullable: true + returnType: + body: *ref_199 + headers: *ref_200 + isNullable: true + serializedName: File_ListFromComputeNode + summary: >- + Lists all of the files in task directories on the specified compute + node. + url: '/pools/{poolId}/nodes/{nodeId}/files' + name: + fixed: false + raw: File + nameForProperty: File + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_110 + headers: *ref_201 + isNullable: true + deprecated: false + extensions: + x-ms-request-id: request-id + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: head + isAbsoluteUrl: false + name: + fixed: false + raw: Exists + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job schedule which you want to check. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobScheduleId + serializedName: jobScheduleId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + headers: *ref_201 + isNullable: true + OK: + headers: *ref_201 + isNullable: true + returnType: + headers: *ref_201 + isNullable: true + serializedName: JobSchedule_Exists + summary: Checks the specified job schedule exists. + url: '/jobschedules/{jobScheduleId}' + - defaultResponse: + body: *ref_110 + headers: *ref_202 + isNullable: true + deprecated: false + description: >- + When you delete a job schedule, this also deletes all jobs and tasks + under that schedule. When tasks are deleted, all the files in their + working directories on the compute nodes are also deleted (the + retention period is ignored). The job schedule statistics are no + longer accessible once the job schedule is deleted, though they are + still counted towards account lifetime statistics. + extensions: + x-ms-examples: + JobSchedule delete: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobScheduleId: jobScheduleId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '202': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job schedule to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobScheduleId + serializedName: jobScheduleId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_202 + isNullable: true + returnType: + headers: *ref_202 + isNullable: true + serializedName: JobSchedule_Delete + summary: Deletes a job schedule from the specified account. + url: '/jobschedules/{jobScheduleId}' + - defaultResponse: + body: *ref_110 + headers: *ref_203 + isNullable: true + deprecated: false + description: Gets information about the specified job schedule. + extensions: + x-ms-examples: + JobSchedule get: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobScheduleId: jobScheduleId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + creationTime: '2016-11-18T21:52:22.5431125Z' + eTag: '0x8D40FFD2E848323' + executionInfo: + endTime: '2016-11-18T21:52:24.8371778Z' + recentJob: + id: 'jobScheduleId:job-1' + url: >- + https://account.region.batch.azure.com/jobschedules/jobScheduleId:job-1 + id: jobScheduleId + jobSpecification: + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: P10675199DT2H48M5.4775807S + onAllTasksComplete: noAction + onTaskFailure: noAction + poolInfo: + poolId: testPool + priority: '0' + usesTaskDependencies: false + lastModified: '2016-11-18T21:52:24.7661347Z' + previousState: active + previousStateTransitionTime: '2016-11-18T21:52:24.0064874Z' + state: completed + stateTransitionTime: '2016-11-18T21:52:24.8371778Z' + url: >- + https://account.region.batch.azure.com/jobschedules/jobScheduleId + x-ms-request-id: request-id + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job schedule to get. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobScheduleId + serializedName: jobScheduleId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $expand clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_74 + headers: *ref_203 + isNullable: true + returnType: + body: *ref_74 + headers: *ref_203 + isNullable: true + serializedName: JobSchedule_Get + url: '/jobschedules/{jobScheduleId}' + - defaultResponse: + body: *ref_110 + headers: *ref_204 + isNullable: true + deprecated: false + description: >- + This replaces only the job schedule properties specified in the + request. For example, if the schedule property is not specified with + this request, then the Batch service will keep the existing schedule. + Changes to a job schedule only impact jobs created by the schedule + after the update has taken place; currently running jobs are + unaffected. + extensions: + x-ms-examples: + JobSchedule patch: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobScheduleId: jobScheduleId + jobSchedulePatchParameter: + jobSpecification: + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: P10675199DT2H48M5.4775807S + poolInfo: + poolId: poolId + priority: '0' + usesTaskDependencies: false + schedule: + doNotRunUntil: '2025-01-01T12:30:00Z' + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: Patch + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job schedule to update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobScheduleId + serializedName: jobScheduleId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: jobSchedulePatchParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_205 + name: + fixed: false + raw: jobSchedulePatchParameter + serializedName: jobSchedulePatchParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_204 + isNullable: true + returnType: + headers: *ref_204 + isNullable: true + serializedName: JobSchedule_Patch + summary: Updates the properties of the specified job schedule. + url: '/jobschedules/{jobScheduleId}' + - defaultResponse: + body: *ref_110 + headers: *ref_206 + isNullable: true + deprecated: false + description: >- + This fully replaces all the updateable properties of the job schedule. + For example, if the schedule property is not specified with this + request, then the Batch service will remove the existing schedule. + Changes to a job schedule only impact jobs created by the schedule + after the update has taken place; currently running jobs are + unaffected. + extensions: + x-ms-examples: + JobSchedule update: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobScheduleId: jobScheduleId + jobScheduleUpdateParameter: + jobSpecification: + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: P10675199DT2H48M5.4775807S + poolInfo: + poolId: poolId + priority: '0' + usesTaskDependencies: false + schedule: + doNotRunUntil: '2025-01-01T12:30:00Z' + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: Update + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job schedule to update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobScheduleId + serializedName: jobScheduleId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: jobScheduleUpdateParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_207 + name: + fixed: false + raw: jobScheduleUpdateParameter + serializedName: jobScheduleUpdateParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_206 + isNullable: true + returnType: + headers: *ref_206 + isNullable: true + serializedName: JobSchedule_Update + summary: Updates the properties of the specified job schedule. + url: '/jobschedules/{jobScheduleId}' + - defaultResponse: + body: *ref_110 + headers: *ref_208 + isNullable: true + deprecated: false + description: No new jobs will be created until the job schedule is enabled again. + extensions: + x-ms-examples: + JobSchedule disable: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobScheduleId: jobScheduleId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '204': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Disable + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job schedule to disable. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobScheduleId + serializedName: jobScheduleId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + headers: *ref_208 + isNullable: true + returnType: + headers: *ref_208 + isNullable: true + serializedName: JobSchedule_Disable + summary: Disables a job schedule. + url: '/jobschedules/{jobScheduleId}/disable' + - defaultResponse: + body: *ref_110 + headers: *ref_209 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + JobSchedule enable: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobScheduleId: jobScheduleId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '204': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Enable + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job schedule to enable. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobScheduleId + serializedName: jobScheduleId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + headers: *ref_209 + isNullable: true + returnType: + headers: *ref_209 + isNullable: true + serializedName: JobSchedule_Enable + summary: Enables a job schedule. + url: '/jobschedules/{jobScheduleId}/enable' + - defaultResponse: + body: *ref_110 + headers: *ref_210 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + JobSchedule terminate: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobScheduleId: jobScheduleId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '202': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Terminate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job schedule to terminates. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobScheduleId + serializedName: jobScheduleId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_210 + isNullable: true + returnType: + headers: *ref_210 + isNullable: true + serializedName: JobSchedule_Terminate + summary: Terminates a job schedule. + url: '/jobschedules/{jobScheduleId}/terminate' + - defaultResponse: + body: *ref_110 + headers: *ref_211 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + Add a basic JobSchedule: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + cloudJobSchedule: + id: jobScheduleId + jobSpecification: + poolInfo: + poolId: poolId + schedule: + recurrenceInterval: PT5M + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '201': + body: '' + Add a complex JobScheduleAdd: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + cloudJobSchedule: + id: jobScheduleId + jobSpecification: + constraints: + maxTaskRetryCount: '-1' + maxWallClockTime: PT1H + jobManagerTask: + commandLine: myprogram.exe + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: PT1H + retentionTime: PT1H + environmentSettings: + - name: myvariable + value: myvalue + id: mytask1 + killJobOnCompletion: true + resourceFiles: + - blobSource: >- + http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?st=2013-08-09T08%3a49%3a37.0000000Z&se=2013-08-10T08%3a49%3a37.0000000Z&sr=c&sp=d&si=YWJjZGTVMZw%3d%3d&sig=%2bSzBm0wi8xECuGkKw97wnkSZ%2f62sxU%2b6Hq6a7qojIVE%3d + filePath: myprogram.exe + - blobSource: >- + http://mystorage1.blob.core.windows.net/scripts/test.txt?st=2013-08-09T08%3a49%3a37.0000000Z&se=2013-08-10T08%3a49%3a37.0000000Z&sr=c&sp=d&si=YWJjZGTVMZw%3d%3d&sig=%2bSzBm0wi8xECuGkKw97wnkSZ%2f62sxU%2b6Hq6a7qojIVE%3d + filePath: test.txt + runExclusive: true + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + poolInfo: + autoPoolSpecification: + autoPoolIdPrefix: mypool + pool: + certificateReferences: + - storeLocation: localMachine + storeName: Root + thumbprint: 0123456789abcdef0123456789abcdef01234567 + thumbprintAlgorithm: sha1 + visibility: + - task + cloudServiceConfiguration: + osFamily: '4' + targetOSVersion: '*' + enableAutoScale: false + enableInterNodeCommunication: true + maxTasksPerNode: '2' + metadata: + - name: myproperty + value: myvalue + resizeTimeout: PT15M + startTask: + commandLine: myprogram2.exe + environmentSettings: + - name: myvariable + value: myvalue + maxTaskRetryCount: '2' + resourceFiles: + - blobSource: >- + http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?st=2013-08-09T08%3a49%3a37.0000000Z&se=2013-08-10T08%3a49%3a37.0000000Z&sr=c&sp=d&si=YWJjZGTVMZw%3d%3d&sig= + %2bSzBm0wi8xECuGkKw97wnkSZ%2f62sxU%2b6Hq6a7qojIVE%3d + filePath: myprogram2.exe + userIdentity: + autoUser: + elevationLevel: admin + scope: task + waitForSuccess: true + targetDedicatedNodes: '3' + targetLowPriorityNodes: '0' + taskSchedulingPolicy: + nodeFillType: spread + vmSize: small + poolLifetimeOption: jobSchedule + priority: '100' + metadata: + - name: myproperty + value: myvalue + schedule: + doNotRunAfter: '2014-09-10T06:30:00Z' + doNotRunUntil: '2014-09-10T02:30:00Z' + recurrenceInterval: PT5M + startWindow: PT1M + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '201': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Add + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The job schedule to be added. + extensions: + x-ms-requestBody-name: cloudJobSchedule + isConstant: false + isRequired: true + location: body + modelType: *ref_212 + name: + fixed: false + raw: cloudJobSchedule + serializedName: cloudJobSchedule + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + headers: *ref_211 + isNullable: true + returnType: + headers: *ref_211 + isNullable: true + serializedName: JobSchedule_Add + summary: Adds a job schedule to the specified account. + url: /jobschedules + - defaultResponse: + body: *ref_110 + headers: *ref_213 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + JobSchedule list: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + value: + - creationTime: '2016-11-18T21:52:22.5431125Z' + eTag: '0x8D40FFD2E10996A' + executionInfo: + recentJob: + id: 'jobSchedule1:job-1' + url: >- + https://account.region.batch.azure.com/jobs/jobSchedule1:job-1 + id: jobSchedule1 + jobSpecification: + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: P10675199DT2H48M5.4775807S + onAllTasksComplete: noAction + onTaskFailure: noAction + poolInfo: + poolId: poolId + priority: '0' + usesTaskDependencies: false + lastModified: '2016-11-18T21:52:24.0064874Z' + previousState: disabled + previousStateTransitionTime: '2016-11-18T21:52:23.6471782Z' + state: active + stateTransitionTime: '2016-11-18T21:52:24.0064874Z' + url: >- + https://account.region.batch.azure.com/jobschedules/jobSchedule1 + - creationTime: '2016-11-18T21:51:05.8184017Z' + eTag: '0x8D40FFCFF760B51' + executionInfo: + nextRunTime: '2020-01-01T12:30:00Z' + id: jobSchedule2 + jobSpecification: + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: P10675199DT2H48M5.4775807S + onAllTasksComplete: noAction + onTaskFailure: noAction + poolInfo: + poolId: testPool2 + priority: '0' + usesTaskDependencies: false + lastModified: '2016-11-18T21:51:05.8184017Z' + schedule: + doNotRunUntil: '2020-01-01T12:30:00Z' + state: active + stateTransitionTime: '2016-11-18T21:51:05.8184017Z' + url: >- + https://account.region.batch.azure.com/jobschedules/jobSchedule2 + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: JobSchedule + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $expand clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 job schedules can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_214 + headers: *ref_213 + isNullable: true + returnType: + body: *ref_214 + headers: *ref_213 + isNullable: true + serializedName: JobSchedule_List + summary: Lists all of the job schedules in the specified account. + url: /jobschedules + name: + fixed: false + raw: JobSchedule + nameForProperty: JobSchedule + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_110 + headers: *ref_215 + isNullable: true + deprecated: false + description: >- + The maximum lifetime of a task from addition to completion is 7 days. + If a task has not completed within 7 days of being added it will be + terminated by the Batch service and left in whatever state it was in + at that time. + extensions: + x-ms-examples: + Add a basic task: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + task: + commandLine: cmd /c echo task1 + id: task1 + responses: + '201': + body: '' + Add a task with container settings: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + task: + commandLine: bash -c 'echo hello' + containerSettings: + containerRunOptions: '--rm' + imageName: ubuntu + id: taskId + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + responses: + '201': + body: '' + Add a task with exit conditions: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + task: + commandLine: cmd /c exit 3 + exitConditions: + exitCodeRanges: + - end: '4' + exitOptions: + jobAction: terminate + start: '2' + id: taskId + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + responses: + '201': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Task + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Add + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job to which the task is to be added. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The task to be added. + extensions: + x-ms-requestBody-name: task + isConstant: false + isRequired: true + location: body + modelType: *ref_107 + name: + fixed: false + raw: task + serializedName: task + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + headers: *ref_215 + isNullable: true + returnType: + headers: *ref_215 + isNullable: true + serializedName: Task_Add + summary: Adds a task to the specified job. + url: '/jobs/{jobId}/tasks' + - defaultResponse: + body: *ref_110 + headers: *ref_216 + isNullable: true + deprecated: false + description: >- + For multi-instance tasks, information such as affinityId, + executionInfo and nodeInfo refer to the primary task. Use the list + subtasks API to retrieve information about subtasks. + extensions: + x-ms-examples: + Task list: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + responses: + '200': + body: + value: + - commandLine: cmd /c echo task1 + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: P10675199DT2H48M5.4775807S + retentionTime: P10675199DT2H48M5.4775807S + creationTime: '2016-11-21T22:43:31.4733476Z' + eTag: '0x8D4125FD1A825A4' + executionInfo: + requeueCount: '0' + retryCount: '0' + id: task1 + lastModified: '2016-11-21T22:43:31.4733476Z' + state: active + stateTransitionTime: '2016-11-21T22:43:31.4733476Z' + url: >- + https://account.region.batch.azure.com/jobs/jobId/tasks/task1 + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + - commandLine: cmd /c echo task2 + constraints: + maxTaskRetryCount: '3' + maxWallClockTime: P10675199DT2H48M5.4775807S + retentionTime: P10675199DT2H48M5.4775807S + creationTime: '2016-11-21T22:43:31.6736345Z' + eTag: '0x8D4125FD2153345' + executionInfo: + requeueCount: '0' + retryCount: '0' + id: task2 + lastModified: '2016-11-21T22:43:32.1880389Z' + state: active + stateTransitionTime: '2016-11-21T22:43:31.6736345Z' + url: >- + https://account.region.batch.azure.com/jobs/jobId/tasks/task2 + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: Task + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $expand clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 tasks can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_217 + headers: *ref_216 + isNullable: true + returnType: + body: *ref_217 + headers: *ref_216 + isNullable: true + serializedName: Task_List + summary: Lists all of the tasks that are associated with the specified job. + url: '/jobs/{jobId}/tasks' + - defaultResponse: + body: *ref_110 + headers: *ref_218 + isNullable: true + deprecated: false + description: >- + Note that each task must have a unique ID. The Batch service may not + return the results for each task in the same order the tasks were + submitted in this request. If the server times out or the connection + is closed during the request, the request may have been partially or + fully processed, or not at all. In such cases, the user should + re-issue the request. Note that it is up to the user to correctly + handle failures when re-issuing a request. For example, you should use + the same task IDs during a retry so that if the prior operation + succeeded, the retry will not create extra tasks unexpectedly. If the + response contains any tasks which failed to add, a client can retry + the request. In a retry, it is most efficient to resubmit only tasks + that failed to add, and to omit tasks that were successfully added on + the first attempt. The maximum lifetime of a task from addition to + completion is 7 days. If a task has not completed within 7 days of + being added it will be terminated by the Batch service and left in + whatever state it was in at that time. + extensions: + x-ms-examples: + Add a basic collection of tasks: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + taskCollection: + value: + - commandLine: cmd /c dir /s + id: simple1 + - commandLine: cmd /c dir /s + id: simple2 + responses: + '200': + body: + value: + - eTag: '0x8D3D623CD661246' + lastModified: '2016-09-06T07:02:44.7589958Z' + location: >- + https://account.region.batch.azure.com/jobs/jobId/tasks/simple1 + status: success + taskId: simple1 + - eTag: '0x8D3D623CD7072CC' + lastModified: '2016-09-06T07:02:44.8270028Z' + location: >- + https://account.region.batch.azure.com/jobs/jobId/tasks/simple2 + status: success + taskId: simple2 + Add a complex collection of tasks: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + taskCollection: + value: + - affinityInfo: + affinityId: affinityId + commandLine: cmd /c dir /s + constraints: + maxTaskRetryCount: '5' + maxWallClockTime: P1D + retentionTime: P2D + environmentSettings: + - name: env1 + value: value1 + - name: env2 + value: value2 + id: complex1 + multiInstanceSettings: + commonResourceFiles: + - blobSource: 'https://common.blob.core.windows.net/' + filePath: common.exe + coordinationCommandLine: cmd /c echo coordinating + numberOfInstances: '3' + resourceFiles: + - blobSource: 'https://account.blob.core.windows.net/' + filePath: file1 + - commandLine: cmd /c dir /s + id: simple3 + responses: + '200': + body: + value: + - eTag: '0x8D3D623CE295629' + lastModified: '2016-09-06T07:02:46.0386857Z' + location: >- + https://account.region.batch.azure.com/jobs/jobId/tasks/simple3 + status: success + taskId: simple3 + - eTag: '0x8D3D623CE29A412' + lastModified: '2016-09-06T07:02:46.0406802Z' + location: >- + https://account.region.batch.azure.com/jobs/jobId/tasks/complex1 + status: success + taskId: complex1 + x-ms-request-id: request-id + x-ms-requestBody-index: '1' + group: + fixed: false + raw: Task + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: AddCollection + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job to which the task collection is to be added. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The tasks to be added. + extensions: + x-ms-requestBody-name: taskCollection + isConstant: false + isRequired: true + location: body + modelType: *ref_219 + name: + fixed: false + raw: taskCollection + serializedName: taskCollection + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_220 + headers: *ref_218 + isNullable: true + returnType: + body: *ref_220 + headers: *ref_218 + isNullable: true + serializedName: Task_AddCollection + summary: Adds a collection of tasks to the specified job. + url: '/jobs/{jobId}/addtaskcollection' + - defaultResponse: + body: *ref_110 + headers: *ref_221 + isNullable: true + deprecated: false + description: >- + When a task is deleted, all of the files in its directory on the + compute node where it ran are also deleted (regardless of the + retention time). For multi-instance tasks, the delete task operation + applies synchronously to the primary task; subtasks and their files + are then deleted asynchronously in the background. + extensions: + x-ms-examples: + Task delete: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + taskId: taskId + responses: + '200': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: Task + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job from which to delete the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_221 + isNullable: true + returnType: + headers: *ref_221 + isNullable: true + serializedName: Task_Delete + summary: Deletes a task from the specified job. + url: '/jobs/{jobId}/tasks/{taskId}' + - defaultResponse: + body: *ref_110 + headers: *ref_222 + isNullable: true + deprecated: false + description: >- + For multi-instance tasks, information such as affinityId, + executionInfo and nodeInfo refer to the primary task. Use the list + subtasks API to retrieve information about subtasks. + extensions: + x-ms-examples: + Task get: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + taskId: taskId + responses: + '200': + body: + commandLine: cmd /c hostname + constraints: + maxTaskRetryCount: '0' + maxWallClockTime: P10675199DT2H48M5.4775807S + retentionTime: P10675199DT2H48M5.4775807S + creationTime: '2016-09-06T06:59:15.1161429Z' + eTag: '0x8D3D62350711C55' + executionInfo: + requeueCount: '0' + retryCount: '0' + id: testTask + lastModified: '2016-09-06T06:59:15.1161429Z' + multiInstanceSettings: + coordinationCommandLine: cmd /c echo coordinating + numberOfInstances: '3' + state: active + stateTransitionTime: '2016-09-06T06:59:15.1161429Z' + url: >- + https://account.region.batch.azure.com/jobs/jobId/tasks/taskId + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + x-ms-request-id: request-id + group: + fixed: false + raw: Task + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job that contains the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task to get information about. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $expand clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_115 + headers: *ref_222 + isNullable: true + returnType: + body: *ref_115 + headers: *ref_222 + isNullable: true + serializedName: Task_Get + summary: Gets information about the specified task. + url: '/jobs/{jobId}/tasks/{taskId}' + - defaultResponse: + body: *ref_110 + headers: *ref_223 + isNullable: true + deprecated: false + description: Updates the properties of the specified task. + extensions: + x-ms-examples: + Task update: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + taskId: taskId + taskUpdateParameter: + constraints: + maxTaskRetryCount: '3' + maxWallClockTime: PT1H + retentionTime: PT1H + responses: + '200': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '2' + group: + fixed: false + raw: Task + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: Update + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job containing the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task to update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: taskUpdateParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_224 + name: + fixed: false + raw: taskUpdateParameter + serializedName: taskUpdateParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_223 + isNullable: true + returnType: + headers: *ref_223 + isNullable: true + serializedName: Task_Update + url: '/jobs/{jobId}/tasks/{taskId}' + - defaultResponse: + body: *ref_110 + headers: *ref_225 + isNullable: true + deprecated: false + description: >- + If the task is not a multi-instance task then this returns an empty + collection. + extensions: + x-ms-examples: + Task list subtasks: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + taskId: taskId + responses: + '200': + body: + value: + - endTime: '2016-09-06T06:59:20.0242024Z' + exitCode: '0' + id: '1' + nodeInfo: + affinityId: 'TVM:tvm-2544493925_3-20160905t051718z' + nodeId: tvm-2544493925_3-20160905t051718z + nodeUrl: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z + poolId: mpiPool + taskRootDirectory: \workitems\jobId\job-1\taskId\1 + taskRootDirectoryUrl: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1 + previousState: running + previousStateTransitionTime: '2016-09-06T06:59:16.3139271Z' + startTime: '2016-09-06T06:59:16.3139271Z' + state: completed + stateTransitionTime: '2016-09-06T06:59:20.0242024Z' + - id: '2' + nodeInfo: + affinityId: 'TVM:tvm-2544493925_2-20160905t051718z' + nodeId: tvm-2544493925_2-20160905t051718z + nodeUrl: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z + poolId: mpiPool + taskRootDirectory: \workitems\jobId\job-1\taskId\2 + taskRootDirectoryUrl: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2 + startTime: '2016-09-06T06:59:16.9702844Z' + state: running + stateTransitionTime: '2016-09-06T06:59:16.9702844Z' + x-ms-request-id: request-id + group: + fixed: false + raw: Task + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListSubtasks + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_226 + headers: *ref_225 + isNullable: true + returnType: + body: *ref_226 + headers: *ref_225 + isNullable: true + serializedName: Task_ListSubtasks + summary: >- + Lists all of the subtasks that are associated with the specified + multi-instance task. + url: '/jobs/{jobId}/tasks/{taskId}/subtasksinfo' + - defaultResponse: + body: *ref_110 + headers: *ref_227 + isNullable: true + deprecated: false + description: >- + When the task has been terminated, it moves to the completed state. + For multi-instance tasks, the terminate task operation applies + synchronously to the primary task; subtasks are then terminated + asynchronously in the background. + extensions: + x-ms-examples: + Task terminate: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + taskId: taskId + responses: + '204': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: Task + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Terminate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job containing the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task to terminate. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + headers: *ref_227 + isNullable: true + returnType: + headers: *ref_227 + isNullable: true + serializedName: Task_Terminate + summary: Terminates the specified task. + url: '/jobs/{jobId}/tasks/{taskId}/terminate' + - defaultResponse: + body: *ref_110 + headers: *ref_228 + isNullable: true + deprecated: false + description: >- + Reactivation makes a task eligible to be retried again up to its + maximum retry count. The task's state is changed to active. As the + task is no longer in the completed state, any previous exit code or + failure information is no longer available after reactivation. Each + time a task is reactivated, its retry count is reset to 0. + Reactivation will fail for tasks that are not completed or that + previously completed successfully (with an exit code of 0). + Additionally, it will fail if the job has completed (or is terminating + or deleting). + extensions: + x-ms-examples: + Task reactivate: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + jobId: jobId + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + taskId: taskId + responses: + '204': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: Task + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Reactivate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the job containing the task. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobId + serializedName: jobId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the task to reactivate. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: taskId + serializedName: taskId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service exactly matches the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-Match + serializedName: If-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An ETag value associated with the version of the resource known + to the client. The operation will be performed only if the + resource's current ETag on the service does not match the value + specified by the client. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: If-None-Match + serializedName: If-None-Match + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has been modified since the specified + time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Modified-Since + serializedName: If-Modified-Since + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A timestamp indicating the last modified time of the resource + known to the client. The operation will be performed only if the + resource on the service has not been modified since the + specified time. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: If-Unmodified-Since + serializedName: If-Unmodified-Since + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + headers: *ref_228 + isNullable: true + returnType: + headers: *ref_228 + isNullable: true + serializedName: Task_Reactivate + summary: >- + Reactivates a task, allowing it to run again even if its retry count + has been exhausted. + url: '/jobs/{jobId}/tasks/{taskId}/reactivate' + name: + fixed: false + raw: Task + nameForProperty: Task + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_110 + headers: *ref_229 + isNullable: true + deprecated: false + description: >- + You can add a user account to a node only when it is in the idle or + running state. + extensions: + x-ms-examples: + Node add user: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeId: tvm-1695681911_1-20161121t182739z + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + user: + expiryTime: '2017-08-01T00:00:00Z' + isAdmin: false + name: userName + password: Password + responses: + '201': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '2' + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: AddUser + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the machine on which you want to create a user + account. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The user account to be created. + extensions: + x-ms-requestBody-name: user + isConstant: false + isRequired: true + location: body + modelType: *ref_230 + name: + fixed: false + raw: user + serializedName: user + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + headers: *ref_229 + isNullable: true + returnType: + headers: *ref_229 + isNullable: true + serializedName: ComputeNode_AddUser + summary: Adds a user account to the specified compute node. + url: '/pools/{poolId}/nodes/{nodeId}/users' + - defaultResponse: + body: *ref_110 + headers: *ref_231 + isNullable: true + deprecated: false + description: >- + You can delete a user account to a node only when it is in the idle or + running state. + extensions: + x-ms-examples: + Node delete user: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeId: tvm-1695681911_1-20161121t182739z + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + userName: userName + responses: + '200': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteUser + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the machine on which you want to delete a user + account. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the user account to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: userName + serializedName: userName + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_231 + isNullable: true + returnType: + headers: *ref_231 + isNullable: true + serializedName: ComputeNode_DeleteUser + summary: Deletes a user account from the specified compute node. + url: '/pools/{poolId}/nodes/{nodeId}/users/{userName}' + - defaultResponse: + body: *ref_110 + headers: *ref_232 + isNullable: true + deprecated: false + description: >- + This operation replaces of all the updateable properties of the + account. For example, if the expiryTime element is not specified, the + current value is replaced with the default value, not left unmodified. + You can update a user account on a node only when it is in the idle or + running state. + extensions: + x-ms-examples: + Node update user: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeId: tvm-1695681911_1-20161121t182739z + nodeUpdateUserParameter: + expiryTime: '2016-11-27T00:45:48.7320857Z' + password: '12345' + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + userName: userName + responses: + '200': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '3' + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateUser + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the machine on which you want to update a user + account. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the user account to update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: userName + serializedName: userName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: nodeUpdateUserParameter + isConstant: false + isRequired: true + location: body + modelType: *ref_233 + name: + fixed: false + raw: nodeUpdateUserParameter + serializedName: nodeUpdateUserParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_232 + isNullable: true + returnType: + headers: *ref_232 + isNullable: true + serializedName: ComputeNode_UpdateUser + summary: >- + Updates the password and expiration time of a user account on the + specified compute node. + url: '/pools/{poolId}/nodes/{nodeId}/users/{userName}' + - defaultResponse: + body: *ref_110 + headers: *ref_234 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + Node get: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeId: tvm-1695681911_2-20161122t193202z + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '200': + body: + affinityId: 'TVM:tvm-1695681911_2-20161122t193202z' + allocationTime: '2016-11-22T19:32:02.8155319Z' + id: tvm-1695681911_2-20161122t193202z + ipAddress: 1.1.1.1 + isDedicated: true + lastBootTime: '2016-11-22T19:37:28.623369Z' + runningTasksCount: '0' + schedulingState: enabled + startTask: + commandLine: cmd /c echo hello + maxTaskRetryCount: '0' + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + waitForSuccess: false + startTaskInfo: + endTime: '2016-11-22T19:37:31.838028Z' + exitCode: '0' + retryCount: '0' + startTime: '2016-11-22T19:37:31.4285526Z' + state: completed + state: idle + stateTransitionTime: '2016-11-22T19:37:31.4285526Z' + totalTasksRun: '0' + totalTasksSucceeded: '0' + url: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z + vmSize: small + x-ms-request-id: request-id + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the compute node that you want to get information + about. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_124 + headers: *ref_234 + isNullable: true + returnType: + body: *ref_124 + headers: *ref_234 + isNullable: true + serializedName: ComputeNode_Get + summary: Gets information about the specified compute node. + url: '/pools/{poolId}/nodes/{nodeId}' + - defaultResponse: + body: *ref_110 + headers: *ref_235 + isNullable: true + deprecated: false + description: You can restart a node only if it is in an idle or running state. + extensions: + x-ms-examples: + Node reboot: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeId: tvm-1695681911_1-20161122t193202z + nodeRebootParameter: + nodeRebootOption: terminate + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '202': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '2' + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Reboot + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the compute node that you want to restart. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: nodeRebootParameter + isConstant: false + isRequired: false + location: body + modelType: *ref_236 + name: + fixed: false + raw: nodeRebootParameter + serializedName: nodeRebootParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_235 + isNullable: true + returnType: + headers: *ref_235 + isNullable: true + serializedName: ComputeNode_Reboot + summary: Restarts the specified compute node. + url: '/pools/{poolId}/nodes/{nodeId}/reboot' + - defaultResponse: + body: *ref_110 + headers: *ref_237 + isNullable: true + deprecated: false + description: >- + You can reinstall the operating system on a node only if it is in an + idle or running state. This API can be invoked only on pools created + with the cloud service configuration property. + extensions: + x-ms-examples: + Node reimage: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeId: tvm-1695681911_1-20161122t193202z + nodeReimageParameter: + nodeReimageOption: terminate + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '202': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '2' + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Reimage + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the compute node that you want to restart. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: nodeReimageParameter + isConstant: false + isRequired: false + location: body + modelType: *ref_238 + name: + fixed: false + raw: nodeReimageParameter + serializedName: nodeReimageParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + headers: *ref_237 + isNullable: true + returnType: + headers: *ref_237 + isNullable: true + serializedName: ComputeNode_Reimage + summary: Reinstalls the operating system on the specified compute node. + url: '/pools/{poolId}/nodes/{nodeId}/reimage' + - defaultResponse: + body: *ref_110 + headers: *ref_239 + isNullable: true + deprecated: false + description: >- + You can disable task scheduling on a node only if its current + scheduling state is enabled. + extensions: + x-ms-examples: + Node disable scheduling: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeDisableSchedulingParameter: + nodeDisableSchedulingOption: terminate + nodeId: tvm-1695681911_1-20161122t193202z + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '200': + body: '' + x-ms-request-id: request-id + x-ms-requestBody-index: '2' + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: DisableScheduling + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the compute node on which you want to disable task + scheduling. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters for the request. + extensions: + x-ms-requestBody-name: nodeDisableSchedulingParameter + isConstant: false + isRequired: false + location: body + modelType: *ref_240 + name: + fixed: false + raw: nodeDisableSchedulingParameter + serializedName: nodeDisableSchedulingParameter + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; odata=minimalmetadata; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_239 + isNullable: true + returnType: + headers: *ref_239 + isNullable: true + serializedName: ComputeNode_DisableScheduling + summary: Disables task scheduling on the specified compute node. + url: '/pools/{poolId}/nodes/{nodeId}/disablescheduling' + - defaultResponse: + body: *ref_110 + headers: *ref_241 + isNullable: true + deprecated: false + description: >- + You can enable task scheduling on a node only if its current + scheduling state is disabled + extensions: + x-ms-examples: + Node enable scheduling: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeId: tvm-1695681911_1-20161122t193202z + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '200': + body: '' + x-ms-request-id: request-id + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: EnableScheduling + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the compute node on which you want to enable task + scheduling. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + headers: *ref_241 + isNullable: true + returnType: + headers: *ref_241 + isNullable: true + serializedName: ComputeNode_EnableScheduling + summary: Enables task scheduling on the specified compute node. + url: '/pools/{poolId}/nodes/{nodeId}/enablescheduling' + - defaultResponse: + body: *ref_110 + headers: *ref_242 + isNullable: true + deprecated: false + description: >- + Before you can remotely login to a node using the remote login + settings, you must create a user account on the node. This API can be + invoked only on pools created with the virtual machine configuration + property. For pools created with a cloud service configuration, see + the GetRemoteDesktop API. + extensions: + x-ms-examples: + Node get remote login settings: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + nodeId: tvm-1695681911_1-20161121t182739z + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '200': + body: + remoteLoginIPAddress: 1.1.1.1 + remoteLoginPort: '50000' + x-ms-request-id: request-id + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetRemoteLoginSettings + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the compute node for which to obtain the remote login + settings. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_243 + headers: *ref_242 + isNullable: true + returnType: + body: *ref_243 + headers: *ref_242 + isNullable: true + serializedName: ComputeNode_GetRemoteLoginSettings + summary: Gets the settings required for remote login to a compute node. + url: '/pools/{poolId}/nodes/{nodeId}/remoteloginsettings' + - defaultResponse: + body: *ref_110 + headers: *ref_244 + isNullable: true + deprecated: false + description: >- + Before you can access a node by using the RDP file, you must create a + user account on the node. This API can only be invoked on pools + created with a cloud service configuration. For pools created with a + virtual machine configuration, see the GetRemoteLoginSettings API. + extensions: + x-ms-request-id: request-id + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetRemoteDesktop + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool that contains the compute node. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of the compute node for which you want to get the Remote + Desktop Protocol file. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeId + serializedName: nodeId + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_245 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + headers: *ref_244 + isNullable: true + returnType: + body: *ref_245 + headers: *ref_244 + isNullable: true + serializedName: ComputeNode_GetRemoteDesktop + summary: Gets the Remote Desktop Protocol file for the specified compute node. + url: '/pools/{poolId}/nodes/{nodeId}/rdp' + - defaultResponse: + body: *ref_110 + headers: *ref_246 + isNullable: true + deprecated: false + extensions: + x-ms-examples: + Node list: + parameters: + api-version: 2017-09-01.6.0 + client-request-id: 00000000-0000-0000-0000-000000000000 + ocp-data: 'Fri, 17 Feb 2017 00:00:00 GMT' + poolId: poolId + responses: + '200': + body: + value: + - affinityId: 'TVM:tvm-1695681911_1-20161122t193202z' + allocationTime: '2016-11-22T19:32:02.8155319Z' + id: tvm-1695681911_1-20161122t193202z + ipAddress: 1.1.1.1 + isDedicated: true + lastBootTime: '2016-11-22T22:22:24.4634125Z' + runningTasksCount: '0' + schedulingState: enabled + startTask: + commandLine: cmd /c echo hello + maxTaskRetryCount: '0' + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + waitForSuccess: false + startTaskInfo: + endTime: '2016-11-22T22:22:27.567189Z' + exitCode: '0' + retryCount: '0' + startTime: '2016-11-22T22:22:27.2236818Z' + state: completed + state: idle + stateTransitionTime: '2016-11-22T22:22:27.2236818Z' + totalTasksRun: '0' + totalTasksSucceeded: '0' + url: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z + vmSize: small + - affinityId: 'TVM:tvm-1695681911_2-20161122t193202z' + allocationTime: '2016-11-22T19:32:02.8155319Z' + id: tvm-1695681911_2-20161122t193202z + ipAddress: 1.1.1.1 + isDedicated: true + lastBootTime: '2016-11-22T19:37:28.623369Z' + runningTasksCount: '0' + schedulingState: enabled + startTask: + commandLine: cmd /c echo hello + maxTaskRetryCount: '0' + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + waitForSuccess: false + startTaskInfo: + endTime: '2016-11-22T19:37:31.838028Z' + exitCode: '0' + retryCount: '0' + startTime: '2016-11-22T19:37:31.4285526Z' + state: completed + state: idle + stateTransitionTime: '2016-11-22T19:37:31.4285526Z' + totalTasksRun: '0' + totalTasksSucceeded: '0' + url: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z + vmSize: small + - affinityId: 'TVM:tvm-1695681911_3-20161122t193202z' + allocationTime: '2016-11-22T19:32:02.8155319Z' + id: tvm-1695681911_3-20161122t193202z + ipAddress: 1.1.1.1 + isDedicated: true + lastBootTime: '2016-11-22T19:36:48.21721Z' + runningTasksCount: '0' + schedulingState: enabled + startTask: + commandLine: cmd /c echo hello + maxTaskRetryCount: '0' + userIdentity: + autoUser: + elevationLevel: nonAdmin + scope: task + waitForSuccess: false + startTaskInfo: + endTime: '2016-11-22T19:36:51.2363447Z' + exitCode: '0' + retryCount: '0' + startTime: '2016-11-22T19:36:51.0013378Z' + state: completed + state: idle + stateTransitionTime: '2016-11-22T19:36:51.0013378Z' + totalTasksRun: '0' + totalTasksSucceeded: '0' + url: >- + https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z + vmSize: small + x-ms-pageable: + nextLinkName: odata.nextLink + x-ms-request-id: request-id + group: + fixed: false + raw: ComputeNode + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the pool from which you want to list nodes. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: poolId + serializedName: poolId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An OData $filter clause. For more information on constructing + this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An OData $select clause. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '1000' + documentation: + fixed: false + raw: >- + The maximum number of items to return in the response. A maximum + of 1000 nodes can be returned. + extensions: + x-ms-client-name: maxResults + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxresults + serializedName: maxresults + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: >- + The maximum time that the server can spend processing the + request, in seconds. The default is 30 seconds. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeout + serializedName: timeout + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The caller-generated request identity, in the form of a GUID + with no decoration such as curly braces, e.g. + 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Whether the server should return the client-request-id in the + response. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: return-client-request-id + serializedName: return-client-request-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time the request was issued. Client libraries typically set + this to the current system clock time; set it explicitly if you + are calling the REST API directly. + extensions: + x-ms-parameter-grouping: + postfix: Options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: date-time-rfc1123 + knownPrimaryType: dateTimeRfc1123 + name: + fixed: false + raw: DateTimeRfc1123 + name: + fixed: false + raw: ocp-date + serializedName: ocp-date + - clientProperty: *ref_133 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_247 + headers: *ref_246 + isNullable: true + returnType: + body: *ref_247 + headers: *ref_246 + isNullable: true + serializedName: ComputeNode_List + summary: Lists the compute nodes in the specified pool. + url: '/pools/{poolId}/nodes' + name: + fixed: false + raw: ComputeNode + nameForProperty: ComputeNode + typeName: + fixed: false +properties: + - *ref_133 diff --git a/test/Expected/specs-compute/code-model-v1-yaml.yaml b/test/Expected/specs-compute/code-model-v1-yaml.yaml new file mode 100644 index 0000000..a69ae0b --- /dev/null +++ b/test/Expected/specs-compute/code-model-v1-yaml.yaml @@ -0,0 +1,20661 @@ +--- +apiVersion: '2017-03-30' +baseUrl: 'https://management.azure.com' +documentation: The Compute Management Client. +enumTypes: + - &ref_0 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: StatusLevelTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Info + serializedName: Info + - name: Warning + serializedName: Warning + - name: Error + serializedName: Error + - &ref_11 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: OperatingSystemTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Windows + serializedName: Windows + - name: Linux + serializedName: Linux + - &ref_20 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: VirtualMachineSizeTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Basic_A0 + serializedName: Basic_A0 + - name: Basic_A1 + serializedName: Basic_A1 + - name: Basic_A2 + serializedName: Basic_A2 + - name: Basic_A3 + serializedName: Basic_A3 + - name: Basic_A4 + serializedName: Basic_A4 + - name: Standard_A0 + serializedName: Standard_A0 + - name: Standard_A1 + serializedName: Standard_A1 + - name: Standard_A2 + serializedName: Standard_A2 + - name: Standard_A3 + serializedName: Standard_A3 + - name: Standard_A4 + serializedName: Standard_A4 + - name: Standard_A5 + serializedName: Standard_A5 + - name: Standard_A6 + serializedName: Standard_A6 + - name: Standard_A7 + serializedName: Standard_A7 + - name: Standard_A8 + serializedName: Standard_A8 + - name: Standard_A9 + serializedName: Standard_A9 + - name: Standard_A10 + serializedName: Standard_A10 + - name: Standard_A11 + serializedName: Standard_A11 + - name: Standard_A1_v2 + serializedName: Standard_A1_v2 + - name: Standard_A2_v2 + serializedName: Standard_A2_v2 + - name: Standard_A4_v2 + serializedName: Standard_A4_v2 + - name: Standard_A8_v2 + serializedName: Standard_A8_v2 + - name: Standard_A2m_v2 + serializedName: Standard_A2m_v2 + - name: Standard_A4m_v2 + serializedName: Standard_A4m_v2 + - name: Standard_A8m_v2 + serializedName: Standard_A8m_v2 + - name: Standard_D1 + serializedName: Standard_D1 + - name: Standard_D2 + serializedName: Standard_D2 + - name: Standard_D3 + serializedName: Standard_D3 + - name: Standard_D4 + serializedName: Standard_D4 + - name: Standard_D11 + serializedName: Standard_D11 + - name: Standard_D12 + serializedName: Standard_D12 + - name: Standard_D13 + serializedName: Standard_D13 + - name: Standard_D14 + serializedName: Standard_D14 + - name: Standard_D1_v2 + serializedName: Standard_D1_v2 + - name: Standard_D2_v2 + serializedName: Standard_D2_v2 + - name: Standard_D3_v2 + serializedName: Standard_D3_v2 + - name: Standard_D4_v2 + serializedName: Standard_D4_v2 + - name: Standard_D5_v2 + serializedName: Standard_D5_v2 + - name: Standard_D11_v2 + serializedName: Standard_D11_v2 + - name: Standard_D12_v2 + serializedName: Standard_D12_v2 + - name: Standard_D13_v2 + serializedName: Standard_D13_v2 + - name: Standard_D14_v2 + serializedName: Standard_D14_v2 + - name: Standard_D15_v2 + serializedName: Standard_D15_v2 + - name: Standard_DS1 + serializedName: Standard_DS1 + - name: Standard_DS2 + serializedName: Standard_DS2 + - name: Standard_DS3 + serializedName: Standard_DS3 + - name: Standard_DS4 + serializedName: Standard_DS4 + - name: Standard_DS11 + serializedName: Standard_DS11 + - name: Standard_DS12 + serializedName: Standard_DS12 + - name: Standard_DS13 + serializedName: Standard_DS13 + - name: Standard_DS14 + serializedName: Standard_DS14 + - name: Standard_DS1_v2 + serializedName: Standard_DS1_v2 + - name: Standard_DS2_v2 + serializedName: Standard_DS2_v2 + - name: Standard_DS3_v2 + serializedName: Standard_DS3_v2 + - name: Standard_DS4_v2 + serializedName: Standard_DS4_v2 + - name: Standard_DS5_v2 + serializedName: Standard_DS5_v2 + - name: Standard_DS11_v2 + serializedName: Standard_DS11_v2 + - name: Standard_DS12_v2 + serializedName: Standard_DS12_v2 + - name: Standard_DS13_v2 + serializedName: Standard_DS13_v2 + - name: Standard_DS14_v2 + serializedName: Standard_DS14_v2 + - name: Standard_DS15_v2 + serializedName: Standard_DS15_v2 + - name: Standard_F1 + serializedName: Standard_F1 + - name: Standard_F2 + serializedName: Standard_F2 + - name: Standard_F4 + serializedName: Standard_F4 + - name: Standard_F8 + serializedName: Standard_F8 + - name: Standard_F16 + serializedName: Standard_F16 + - name: Standard_F1s + serializedName: Standard_F1s + - name: Standard_F2s + serializedName: Standard_F2s + - name: Standard_F4s + serializedName: Standard_F4s + - name: Standard_F8s + serializedName: Standard_F8s + - name: Standard_F16s + serializedName: Standard_F16s + - name: Standard_G1 + serializedName: Standard_G1 + - name: Standard_G2 + serializedName: Standard_G2 + - name: Standard_G3 + serializedName: Standard_G3 + - name: Standard_G4 + serializedName: Standard_G4 + - name: Standard_G5 + serializedName: Standard_G5 + - name: Standard_GS1 + serializedName: Standard_GS1 + - name: Standard_GS2 + serializedName: Standard_GS2 + - name: Standard_GS3 + serializedName: Standard_GS3 + - name: Standard_GS4 + serializedName: Standard_GS4 + - name: Standard_GS5 + serializedName: Standard_GS5 + - name: Standard_H8 + serializedName: Standard_H8 + - name: Standard_H16 + serializedName: Standard_H16 + - name: Standard_H8m + serializedName: Standard_H8m + - name: Standard_H16m + serializedName: Standard_H16m + - name: Standard_H16r + serializedName: Standard_H16r + - name: Standard_H16mr + serializedName: Standard_H16mr + - name: Standard_L4s + serializedName: Standard_L4s + - name: Standard_L8s + serializedName: Standard_L8s + - name: Standard_L16s + serializedName: Standard_L16s + - name: Standard_L32s + serializedName: Standard_L32s + - name: Standard_NC6 + serializedName: Standard_NC6 + - name: Standard_NC12 + serializedName: Standard_NC12 + - name: Standard_NC24 + serializedName: Standard_NC24 + - name: Standard_NC24r + serializedName: Standard_NC24r + - name: Standard_NV6 + serializedName: Standard_NV6 + - name: Standard_NV12 + serializedName: Standard_NV12 + - name: Standard_NV24 + serializedName: Standard_NV24 + - &ref_26 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: CachingTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: None + serializedName: None + - name: ReadOnly + serializedName: ReadOnly + - name: ReadWrite + serializedName: ReadWrite + - &ref_27 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: DiskCreateOptionTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: FromImage + serializedName: FromImage + - name: Empty + serializedName: Empty + - name: Attach + serializedName: Attach + - &ref_23 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: StorageAccountTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Standard_LRS + serializedName: Standard_LRS + - name: Premium_LRS + serializedName: Premium_LRS + - &ref_32 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: PassNames + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: OobeSystem + serializedName: OobeSystem + - &ref_33 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ComponentNames + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Microsoft-Windows-Shell-Setup + serializedName: Microsoft-Windows-Shell-Setup + - &ref_34 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: SettingNames + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: AutoLogon + serializedName: AutoLogon + - name: FirstLogonCommands + serializedName: FirstLogonCommands + - &ref_35 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ProtocolTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Http + serializedName: Http + - name: Https + serializedName: Https + - &ref_49 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ResourceIdentityType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: SystemAssigned + serializedName: SystemAssigned + - &ref_50 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: MaintenanceOperationResultCodeTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: None + serializedName: None + - name: RetryLater + serializedName: RetryLater + - name: MaintenanceAborted + serializedName: MaintenanceAborted + - name: MaintenanceCompleted + serializedName: MaintenanceCompleted + - &ref_66 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: UpgradeMode + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Automatic + serializedName: Automatic + - name: Manual + serializedName: Manual + - name: Rolling + serializedName: Rolling + - &ref_68 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: OperatingSystemStateTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Generalized + serializedName: Generalized + - name: Specialized + serializedName: Specialized + - &ref_74 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ResourceSkuCapacityScaleType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Automatic + serializedName: Automatic + - name: Manual + serializedName: Manual + - name: None + serializedName: None + - &ref_75 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ResourceSkuRestrictionsType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Location + serializedName: Location + - &ref_76 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ResourceSkuRestrictionsReasonCode + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: QuotaId + serializedName: QuotaId + - name: NotAvailableForSubscription + serializedName: NotAvailableForSubscription + - &ref_90 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: IPVersion + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: IPv4 + serializedName: IPv4 + - name: IPv6 + serializedName: IPv6 + - &ref_121 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: VirtualMachineScaleSetSkuScaleType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Automatic + serializedName: Automatic + - name: None + serializedName: None + - &ref_127 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: RollingUpgradeStatusCode + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: RollingForward + serializedName: RollingForward + - name: Cancelled + serializedName: Cancelled + - name: Completed + serializedName: Completed + - name: Faulted + serializedName: Faulted + - &ref_128 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: RollingUpgradeActionType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Start + serializedName: Start + - name: Cancel + serializedName: Cancel + - &ref_155 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: InstanceViewTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: instanceView + serializedName: instanceView +extensions: + security: + - azure_auth: + - user_impersonation +modelTypes: + - &ref_2 + $type: CompositeType + containsConstantProperties: false + documentation: Instance view status. + name: + fixed: false + raw: InstanceViewStatus + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The status code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The level code. + extensions: + x-ms-enum: + modelAsString: false + name: StatusLevelTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: level + realPath: + - level + serializedName: level + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The short localizable label for the status. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: displayStatus + realPath: + - displayStatus + serializedName: displayStatus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The detailed status message, including for alerts and error + messages. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time of the status. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: time + realPath: + - time + serializedName: time + serializedName: InstanceViewStatus + - &ref_1 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: SubResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: SubResource + - &ref_3 + $type: CompositeType + containsConstantProperties: false + documentation: The instance view of a resource. + name: + fixed: false + raw: AvailabilitySetProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Update Domain count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: platformUpdateDomainCount + realPath: + - platformUpdateDomainCount + serializedName: platformUpdateDomainCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Fault Domain count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: platformFaultDomainCount + realPath: + - platformFaultDomainCount + serializedName: platformFaultDomainCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A list of references to all virtual machines in the availability + set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: virtualMachines + realPath: + - virtualMachines + serializedName: virtualMachines + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The resource status information. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_2 + name: + fixed: false + name: + fixed: false + raw: statuses + realPath: + - statuses + serializedName: statuses + serializedName: AvailabilitySetProperties + - &ref_4 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set sku. + name: + fixed: false + raw: Sku + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The sku name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the tier of virtual machines in a scale set.

+ Possible Values:

**Standard**

**Basic** + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tier + realPath: + - tier + serializedName: tier + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the number of virtual machines in the scale set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: capacity + realPath: + - capacity + serializedName: capacity + serializedName: Sku + - &ref_5 + $type: CompositeType + baseModelType: &ref_7 + $type: CompositeType + containsConstantProperties: false + documentation: The Resource model definition. + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: Resource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource name + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource type + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource location + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource tags + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + serializedName: Resource + containsConstantProperties: false + documentation: >- + Specifies information about the availability set that the virtual machine + should be assigned to. Virtual machines specified in the same availability + set are allocated to different nodes to maximize availability. For more + information about availability sets, see [Manage the availability of + virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). +

For more information on Azure planned maintainance, see [Planned + maintenance for virtual machines in + Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) +

Currently, a VM can only be added to availability set at creation + time. An existing VM cannot be added to an availability set. + name: + fixed: false + raw: AvailabilitySet + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Sku of the availability set + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_4 + name: + fixed: false + raw: sku + realPath: + - sku + serializedName: sku + serializedName: AvailabilitySet + - &ref_140 + $type: CompositeType + containsConstantProperties: false + documentation: The List Availability Set operation response. + name: + fixed: false + raw: AvailabilitySetListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of availability sets + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_5 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: AvailabilitySetListResult + - &ref_6 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of a VM size. + name: + fixed: false + raw: VirtualMachineSize + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine size. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The number of cores supported by the virtual machine size. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: numberOfCores + realPath: + - numberOfCores + serializedName: numberOfCores + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The OS disk size, in MB, allowed by the virtual machine size.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: osDiskSizeInMB + realPath: + - osDiskSizeInMB + serializedName: osDiskSizeInMB + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The resource disk size, in MB, allowed by the virtual machine size.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: resourceDiskSizeInMB + realPath: + - resourceDiskSizeInMB + serializedName: resourceDiskSizeInMB + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The amount of memory, in MB, supported by the virtual machine size.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: memoryInMB + realPath: + - memoryInMB + serializedName: memoryInMB + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The maximum number of data disks that can be attached to the virtual + machine size. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxDataDiskCount + realPath: + - maxDataDiskCount + serializedName: maxDataDiskCount + serializedName: VirtualMachineSize + - &ref_141 + $type: CompositeType + containsConstantProperties: false + documentation: The List Virtual Machine operation response. + name: + fixed: false + raw: VirtualMachineSizeListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of virtual machine sizes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_6 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: VirtualMachineSizeListResult + - &ref_8 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of a Virtual Machine Extension Image. + name: + fixed: false + raw: VirtualMachineExtensionImageProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The operating system this extension supports. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: operatingSystem + realPath: + - operatingSystem + serializedName: operatingSystem + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The type of role (IaaS or PaaS) this extension supports. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: computeRole + realPath: + - computeRole + serializedName: computeRole + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The schema defined by publisher, where extension consumers should + provide settings in a matching schema. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: handlerSchema + realPath: + - handlerSchema + serializedName: handlerSchema + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Whether the extension can be used on xRP VMScaleSets. By default + existing extensions are usable on scalesets, but there might be + cases where a publisher wants to explicitly indicate the extension + is only enabled for CRP VMs but not VMSS. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: vmScaleSetEnabled + realPath: + - vmScaleSetEnabled + serializedName: vmScaleSetEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Whether the handler can support multiple extensions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: supportsMultipleExtensions + realPath: + - supportsMultipleExtensions + serializedName: supportsMultipleExtensions + serializedName: VirtualMachineExtensionImageProperties + - &ref_142 + $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + documentation: Describes a Virtual Machine Extension Image. + name: + fixed: false + raw: VirtualMachineExtensionImage + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_8 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineExtensionImage + - &ref_15 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: Virtual machine image resource information. + name: + fixed: false + raw: VirtualMachineImageResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The supported Azure location of the resource. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the tags that are assigned to the virtual machine. For + more information about using tags, see [Using tags to organize your + Azure + resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + serializedName: VirtualMachineImageResource + - &ref_9 + $type: CompositeType + containsConstantProperties: false + documentation: The instance view of a virtual machine extension. + name: + fixed: false + raw: VirtualMachineExtensionInstanceView + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine extension name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the type of the extension; an example is + "CustomScriptExtension". + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the version of the script handler. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: typeHandlerVersion + realPath: + - typeHandlerVersion + serializedName: typeHandlerVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The resource status information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_2 + name: + fixed: false + name: + fixed: false + raw: substatuses + realPath: + - substatuses + serializedName: substatuses + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The resource status information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_2 + name: + fixed: false + name: + fixed: false + raw: statuses + realPath: + - statuses + serializedName: statuses + serializedName: VirtualMachineExtensionInstanceView + - &ref_10 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of a Virtual Machine Extension. + name: + fixed: false + raw: VirtualMachineExtensionProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + How the extension handler should be forced to update even if the + extension configuration has not changed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: forceUpdateTag + realPath: + - forceUpdateTag + serializedName: forceUpdateTag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the extension handler publisher. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisher + realPath: + - publisher + serializedName: publisher + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the type of the extension; an example is + "CustomScriptExtension". + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the version of the script handler. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: typeHandlerVersion + realPath: + - typeHandlerVersion + serializedName: typeHandlerVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Indicates whether the extension should use a newer minor version if + one is available at deployment time. Once deployed, however, the + extension will not upgrade minor versions unless redeployed, even + with this property set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: autoUpgradeMinorVersion + realPath: + - autoUpgradeMinorVersion + serializedName: autoUpgradeMinorVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Json formatted public settings for the extension. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: settings + realPath: + - settings + serializedName: settings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The extension can contain either protectedSettings or + protectedSettingsFromKeyVault or no protected settings at all. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: protectedSettings + realPath: + - protectedSettings + serializedName: protectedSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The provisioning state, which only appears in the response.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine extension instance view. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_9 + name: + fixed: false + raw: instanceView + realPath: + - instanceView + serializedName: instanceView + serializedName: VirtualMachineExtensionProperties + - &ref_63 + $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + documentation: Describes a Virtual Machine Extension. + name: + fixed: false + raw: VirtualMachineExtension + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_10 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineExtension + - &ref_12 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Used for establishing the purchase context of any 3rd Party artifact + through MarketPlace. + name: + fixed: false + raw: PurchasePlan + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The publisher ID. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisher + realPath: + - publisher + serializedName: publisher + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The plan ID. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the product of the image from the marketplace. This is the + same value as Offer under the imageReference element. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: product + realPath: + - product + serializedName: product + serializedName: PurchasePlan + - &ref_13 + $type: CompositeType + containsConstantProperties: false + documentation: Contains the os disk image information. + name: + fixed: false + raw: OSDiskImage + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The operating system of the osDiskImage. + extensions: + x-ms-enum: + modelAsString: false + name: OperatingSystemTypes + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_11 + name: + fixed: false + raw: operatingSystem + realPath: + - operatingSystem + serializedName: operatingSystem + serializedName: OSDiskImage + - &ref_14 + $type: CompositeType + containsConstantProperties: false + documentation: Contains the data disk images information. + name: + fixed: false + raw: DataDiskImage + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the logical unit number of the data disk. This value is + used to identify data disks within the VM and therefore must be + unique for each data disk attached to a VM. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: lun + realPath: + - lun + serializedName: lun + serializedName: DataDiskImage + - &ref_16 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of a Virtual Machine Image. + name: + fixed: false + raw: VirtualMachineImageProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_12 + name: + fixed: false + raw: plan + realPath: + - plan + serializedName: plan + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_13 + name: + fixed: false + raw: osDiskImage + realPath: + - osDiskImage + serializedName: osDiskImage + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_14 + name: + fixed: false + name: + fixed: false + raw: dataDiskImages + realPath: + - dataDiskImages + serializedName: dataDiskImages + serializedName: VirtualMachineImageProperties + - &ref_145 + $type: CompositeType + baseModelType: *ref_15 + containsConstantProperties: false + documentation: Describes a Virtual Machine Image. + name: + fixed: false + raw: VirtualMachineImage + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_16 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineImage + - &ref_17 + $type: CompositeType + containsConstantProperties: false + documentation: The Usage Names. + name: + fixed: false + raw: UsageName + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The localized name of the resource. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localizedValue + realPath: + - localizedValue + serializedName: localizedValue + serializedName: UsageName + - &ref_18 + $type: CompositeType + containsConstantProperties: true + documentation: Describes Compute Resource Usage. + name: + fixed: false + raw: Usage + properties: + - collectionFormat: none + defaultValue: + fixed: false + raw: Count + documentation: + fixed: false + raw: An enum describing the unit of usage measurement. + extensions: + x-ms-enum: + modelAsString: false + name: UsageUnit + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: unit + realPath: + - unit + serializedName: unit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The current usage of the resource. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: currentValue + realPath: + - currentValue + serializedName: currentValue + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The maximum permitted usage of the resource. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: limit + realPath: + - limit + serializedName: limit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the type of usage. + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_17 + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: Usage + - &ref_150 + $type: CompositeType + containsConstantProperties: false + documentation: The List Usages operation response. + name: + fixed: false + raw: ListUsagesResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of compute resource usages. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_18 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The URI to fetch the next page of compute resource usage + information. Call ListNext() with this to fetch the next page of + compute resource usage information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ListUsagesResult + - &ref_153 + $type: CompositeType + containsConstantProperties: false + documentation: Capture Virtual Machine parameters. + name: + fixed: false + raw: VirtualMachineCaptureParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The captured virtual hard disk's name prefix. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vhdPrefix + realPath: + - vhdPrefix + serializedName: vhdPrefix + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The destination container name. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: destinationContainerName + realPath: + - destinationContainerName + serializedName: destinationContainerName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies whether to overwrite the destination virtual hard disk, in + case of conflict. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: overwriteVhds + realPath: + - overwriteVhds + serializedName: overwriteVhds + serializedName: VirtualMachineCaptureParameters + - &ref_19 + $type: CompositeType + containsConstantProperties: false + documentation: 'Compute-specific operation properties, including output' + name: + fixed: false + raw: VirtualMachineCaptureResultProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Operation output data (raw JSON) + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: output + realPath: + - output + serializedName: output + serializedName: VirtualMachineCaptureResultProperties + - &ref_154 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: Resource Id. + name: + fixed: false + raw: VirtualMachineCaptureResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_19 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineCaptureResult + - &ref_61 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Specifies information about the marketplace image used to create the + virtual machine. This element is only used for marketplace images. Before + you can use a marketplace image from an API, you must enable the image for + programmatic use. In the Azure portal, find the marketplace image that + you want to use and then click **Want to deploy programmatically, Get + Started ->**. Enter any required information and then click **Save**. + name: + fixed: false + raw: Plan + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The plan ID. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The publisher ID. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisher + realPath: + - publisher + serializedName: publisher + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the product of the image from the marketplace. This is the + same value as Offer under the imageReference element. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: product + realPath: + - product + serializedName: product + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The promotion code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: promotionCode + realPath: + - promotionCode + serializedName: promotionCode + serializedName: Plan + - &ref_55 + $type: CompositeType + containsConstantProperties: false + documentation: Specifies the hardware settings for the virtual machine. + name: + fixed: false + raw: HardwareProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the size of the virtual machine. For more information + about virtual machine sizes, see [Sizes for virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). +

The available VM sizes depend on region and availability + set. For a list of available sizes use these APIs:

[List + all available virtual machine sizes in an availability + set](virtualmachines-list-sizes-availability-set.md)

[List + all available virtual machine sizes in a + region](virtualmachines-list-sizes-region.md)

[List all + available virtual machine sizes for + resizing](virtualmachines-list-sizes-for-resizing.md) + extensions: + x-ms-enum: + modelAsString: true + name: VirtualMachineSizeTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_20 + name: + fixed: false + raw: vmSize + realPath: + - vmSize + serializedName: vmSize + serializedName: HardwareProfile + - &ref_29 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: >- + Specifies information about the image to use. You can specify information + about platform images, marketplace images, or virtual machine images. This + element is required when you want to use a platform image, marketplace + image, or virtual machine image, but is not used in other creation + operations. + name: + fixed: false + raw: ImageReference + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The image publisher. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisher + realPath: + - publisher + serializedName: publisher + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the offer of the platform image or marketplace image used + to create the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: offer + realPath: + - offer + serializedName: offer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The image SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sku + realPath: + - sku + serializedName: sku + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the version of the platform image or marketplace image + used to create the virtual machine. The allowed formats are + Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal + numbers. Specify 'latest' to use the latest version of an image + available at deploy time. Even if you use 'latest', the VM image + will not automatically update after deploy time even if a new + version becomes available. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: version + realPath: + - version + serializedName: version + serializedName: ImageReference + - &ref_21 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a reference to Key Vault Secret + name: + fixed: false + raw: KeyVaultSecretReference + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The URL referencing a secret in a Key Vault. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: secretUrl + realPath: + - secretUrl + serializedName: secretUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relative URL of the Key Vault containing the secret. + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_1 + name: + fixed: false + raw: sourceVault + realPath: + - sourceVault + serializedName: sourceVault + serializedName: KeyVaultSecretReference + - &ref_22 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a reference to Key Vault Key + name: + fixed: false + raw: KeyVaultKeyReference + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The URL referencing a key encryption key in Key Vault. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: keyUrl + realPath: + - keyUrl + serializedName: keyUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relative URL of the Key Vault containing the key. + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_1 + name: + fixed: false + raw: sourceVault + realPath: + - sourceVault + serializedName: sourceVault + serializedName: KeyVaultKeyReference + - &ref_24 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a Encryption Settings for a Disk + name: + fixed: false + raw: DiskEncryptionSettings + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the location of the disk encryption key, which is a Key + Vault Secret. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_21 + name: + fixed: false + raw: diskEncryptionKey + realPath: + - diskEncryptionKey + serializedName: diskEncryptionKey + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the location of the key encryption key in Key Vault. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_22 + name: + fixed: false + raw: keyEncryptionKey + realPath: + - keyEncryptionKey + serializedName: keyEncryptionKey + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies whether disk encryption should be enabled on the virtual + machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enabled + realPath: + - enabled + serializedName: enabled + serializedName: DiskEncryptionSettings + - &ref_25 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the uri of a disk. + name: + fixed: false + raw: VirtualHardDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the virtual hard disk's uri. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: uri + realPath: + - uri + serializedName: uri + serializedName: VirtualHardDisk + - &ref_28 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: The parameters of a managed disk. + name: + fixed: false + raw: ManagedDiskParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the storage account type for the managed disk. Possible + values are: Standard_LRS or Premium_LRS. + extensions: + x-ms-enum: + modelAsString: false + name: StorageAccountTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_23 + name: + fixed: false + raw: storageAccountType + realPath: + - storageAccountType + serializedName: storageAccountType + serializedName: ManagedDiskParameters + - &ref_30 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Specifies information about the operating system disk used by the virtual + machine.

For more information about disks, see [About disks and + VHDs for Azure virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + name: + fixed: false + raw: OSDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property allows you to specify the type of the OS that is + included in the disk if creating a VM from user-image or a + specialized VHD.

Possible values are:

**Windows** +

**Linux** + extensions: + x-ms-enum: + modelAsString: false + name: OperatingSystemTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_11 + name: + fixed: false + raw: osType + realPath: + - osType + serializedName: osType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the encryption settings for the OS Disk.

Minimum + api-version: 2015-06-15 + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_24 + name: + fixed: false + raw: encryptionSettings + realPath: + - encryptionSettings + serializedName: encryptionSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The disk name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual hard disk. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_25 + name: + fixed: false + raw: vhd + realPath: + - vhd + serializedName: vhd + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The source user image virtual hard disk. The virtual hard disk will + be copied before being attached to the virtual machine. If + SourceImage is provided, the destination virtual hard drive must not + exist. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_25 + name: + fixed: false + raw: image + realPath: + - image + serializedName: image + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the caching requirements.

Possible values are: +

**None**

**ReadOnly**

**ReadWrite** +

Default: **None for Standard storage. ReadOnly for Premium + storage** + extensions: + x-ms-enum: + modelAsString: false + name: CachingTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: caching + realPath: + - caching + serializedName: caching + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies how the virtual machine should be created.

+ Possible values are:

**Attach** \u2013 This value is used + when you are using a specialized disk to create the virtual + machine.

**FromImage** \u2013 This value is used when you + are using an image to create the virtual machine. If you are using a + platform image, you also use the imageReference element described + above. If you are using a marketplace image, you also use the plan + element previously described. + extensions: + x-ms-enum: + modelAsString: false + name: DiskCreateOptionTypes + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_27 + name: + fixed: false + raw: createOption + realPath: + - createOption + serializedName: createOption + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the size of an empty data disk in gigabytes. This element + can be used to overwrite the name of the disk in a virtual machine + image.

This value cannot be larger than 1023 GB + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: diskSizeGB + realPath: + - diskSizeGB + serializedName: diskSizeGB + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The managed disk parameters. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_28 + name: + fixed: false + raw: managedDisk + realPath: + - managedDisk + serializedName: managedDisk + serializedName: OSDisk + - &ref_31 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a data disk. + name: + fixed: false + raw: DataDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the logical unit number of the data disk. This value is + used to identify data disks within the VM and therefore must be + unique for each data disk attached to a VM. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: lun + realPath: + - lun + serializedName: lun + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The disk name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual hard disk. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_25 + name: + fixed: false + raw: vhd + realPath: + - vhd + serializedName: vhd + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The source user image virtual hard disk. The virtual hard disk will + be copied before being attached to the virtual machine. If + SourceImage is provided, the destination virtual hard drive must not + exist. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_25 + name: + fixed: false + raw: image + realPath: + - image + serializedName: image + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the caching requirements.

Possible values are: +

**None**

**ReadOnly**

**ReadWrite** +

Default: **None for Standard storage. ReadOnly for Premium + storage** + extensions: + x-ms-enum: + modelAsString: false + name: CachingTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: caching + realPath: + - caching + serializedName: caching + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies how the virtual machine should be created.

+ Possible values are:

**Attach** \u2013 This value is used + when you are using a specialized disk to create the virtual + machine.

**FromImage** \u2013 This value is used when you + are using an image to create the virtual machine. If you are using a + platform image, you also use the imageReference element described + above. If you are using a marketplace image, you also use the plan + element previously described. + extensions: + x-ms-enum: + modelAsString: false + name: DiskCreateOptionTypes + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_27 + name: + fixed: false + raw: createOption + realPath: + - createOption + serializedName: createOption + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the size of an empty data disk in gigabytes. This element + can be used to overwrite the name of the disk in a virtual machine + image.

This value cannot be larger than 1023 GB + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: diskSizeGB + realPath: + - diskSizeGB + serializedName: diskSizeGB + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The managed disk parameters. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_28 + name: + fixed: false + raw: managedDisk + realPath: + - managedDisk + serializedName: managedDisk + serializedName: DataDisk + - &ref_56 + $type: CompositeType + containsConstantProperties: false + documentation: Specifies the storage settings for the virtual machine disks. + name: + fixed: false + raw: StorageProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the image to use. You can specify + information about platform images, marketplace images, or virtual + machine images. This element is required when you want to use a + platform image, marketplace image, or virtual machine image, but is + not used in other creation operations. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_29 + name: + fixed: false + raw: imageReference + realPath: + - imageReference + serializedName: imageReference + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the operating system disk used by the + virtual machine.

For more information about disks, see + [About disks and VHDs for Azure virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_30 + name: + fixed: false + raw: osDisk + realPath: + - osDisk + serializedName: osDisk + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the parameters that are used to add a data disk to a + virtual machine.

For more information about disks, see + [About disks and VHDs for Azure virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_31 + name: + fixed: false + name: + fixed: false + raw: dataDisks + realPath: + - dataDisks + serializedName: dataDisks + serializedName: StorageProfile + - &ref_37 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Specifies additional XML formatted information that can be included in the + Unattend.xml file, which is used by Windows Setup. Contents are defined by + setting name, component name, and the pass in which the content is + applied. + name: + fixed: false + raw: AdditionalUnattendContent + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The pass name. Currently, the only allowable value is oobeSystem.' + extensions: + x-ms-enum: + modelAsString: false + name: PassNames + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_32 + name: + fixed: false + raw: passName + realPath: + - passName + serializedName: passName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The component name. Currently, the only allowable value is + Microsoft-Windows-Shell-Setup. + extensions: + x-ms-enum: + modelAsString: false + name: ComponentNames + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_33 + name: + fixed: false + raw: componentName + realPath: + - componentName + serializedName: componentName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the name of the setting to which the content applies. + Possible values are: FirstLogonCommands and AutoLogon. + extensions: + x-ms-enum: + modelAsString: false + name: SettingNames + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_34 + name: + fixed: false + raw: settingName + realPath: + - settingName + serializedName: settingName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the XML formatted content that is added to the + unattend.xml file for the specified path and component. The XML must + be less than 4KB and must include the root element for the setting + or feature that is being inserted. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: content + realPath: + - content + serializedName: content + serializedName: AdditionalUnattendContent + - &ref_36 + $type: CompositeType + containsConstantProperties: false + documentation: Describes Protocol and thumbprint of Windows Remote Management listener + name: + fixed: false + raw: WinRMListener + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the protocol of listener.

Possible values are: +
**http**

**https** + extensions: + x-ms-enum: + modelAsString: false + name: ProtocolTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_35 + name: + fixed: false + raw: protocol + realPath: + - protocol + serializedName: protocol + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the URL of a certificate that has been uploaded to Key Vault + as a secret. For adding a secret to the Key Vault, see [Add a key or + secret to the key + vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). + In this case, your certificate needs to be It is the Base64 encoding + of the following JSON Object which is encoded in UTF-8:

+ {
"data":"",
+ "dataType":"pfx",
"password":""
} + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: certificateUrl + realPath: + - certificateUrl + serializedName: certificateUrl + serializedName: WinRMListener + - &ref_38 + $type: CompositeType + containsConstantProperties: false + documentation: Describes Windows Remote Management configuration of the VM + name: + fixed: false + raw: WinRMConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of Windows Remote Management listeners + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_36 + name: + fixed: false + name: + fixed: false + raw: listeners + realPath: + - listeners + serializedName: listeners + serializedName: WinRMConfiguration + - &ref_42 + $type: CompositeType + containsConstantProperties: false + documentation: Specifies Windows operating system settings on the virtual machine. + name: + fixed: false + raw: WindowsConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Indicates whether virtual machine agent should be provisioned on the + virtual machine.

When this property is not specified in the + request body, default behavior is to set it to true. This will + ensure that VM Agent is installed on the VM so that extensions can + be added to the VM later. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: provisionVMAgent + realPath: + - provisionVMAgent + serializedName: provisionVMAgent + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Indicates whether virtual machine is enabled for automatic updates. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableAutomaticUpdates + realPath: + - enableAutomaticUpdates + serializedName: enableAutomaticUpdates + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the time zone of the virtual machine. e.g. "Pacific + Standard Time" + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timeZone + realPath: + - timeZone + serializedName: timeZone + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies additional base-64 encoded XML formatted information that + can be included in the Unattend.xml file, which is used by Windows + Setup. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_37 + name: + fixed: false + name: + fixed: false + raw: additionalUnattendContent + realPath: + - additionalUnattendContent + serializedName: additionalUnattendContent + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the Windows Remote Management listeners. This enables + remote Windows PowerShell. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_38 + name: + fixed: false + raw: winRM + realPath: + - winRM + serializedName: winRM + serializedName: WindowsConfiguration + - &ref_39 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Contains information about SSH certificate public key and the path on the + Linux VM where the public key is placed. + name: + fixed: false + raw: SshPublicKey + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the full path on the created VM where ssh public key is + stored. If the file already exists, the specified key is appended to + the file. Example: /home/user/.ssh/authorized_keys + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + realPath: + - path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + SSH public key certificate used to authenticate with the VM through + ssh. The key needs to be at least 2048-bit and in ssh-rsa format. +

For creating ssh keys, see [Create SSH keys on Linux and + Mac for Linux VMs in + Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: keyData + realPath: + - keyData + serializedName: keyData + serializedName: SshPublicKey + - &ref_40 + $type: CompositeType + containsConstantProperties: false + documentation: SSH configuration for Linux based VMs running on Azure + name: + fixed: false + raw: SshConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The list of SSH public keys used to authenticate with linux based + VMs. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_39 + name: + fixed: false + name: + fixed: false + raw: publicKeys + realPath: + - publicKeys + serializedName: publicKeys + serializedName: SshConfiguration + - &ref_43 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Specifies the Linux operating system settings on the virtual machine. +

For a list of supported Linux distributions, see [Linux on + Azure-Endorsed + Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) +

For running non-endorsed distributions, see [Information for + Non-Endorsed + Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + name: + fixed: false + raw: LinuxConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies whether password authentication should be disabled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: disablePasswordAuthentication + realPath: + - disablePasswordAuthentication + serializedName: disablePasswordAuthentication + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the ssh key configuration for a Linux OS. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_40 + name: + fixed: false + raw: ssh + realPath: + - ssh + serializedName: ssh + serializedName: LinuxConfiguration + - &ref_41 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a single certificate reference in a Key Vault, and where the + certificate should reside on the VM. + name: + fixed: false + raw: VaultCertificate + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This is the URL of a certificate that has been uploaded to Key Vault + as a secret. For adding a secret to the Key Vault, see [Add a key or + secret to the key + vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). + In this case, your certificate needs to be It is the Base64 encoding + of the following JSON Object which is encoded in UTF-8:

+ {
"data":"",
+ "dataType":"pfx",
"password":""
} + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: certificateUrl + realPath: + - certificateUrl + serializedName: certificateUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + For Windows VMs, specifies the certificate store on the Virtual + Machine to which the certificate should be added. The specified + certificate store is implicitly in the LocalMachine account. +

For Linux VMs, the certificate file is placed under the + /var/lib/waagent directory, with the file name + .crt for the X509 certificate file and + .prv for private key. Both of these files are + .pem formatted. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: certificateStore + realPath: + - certificateStore + serializedName: certificateStore + serializedName: VaultCertificate + - &ref_44 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a set of certificates which are all in the same Key Vault. + name: + fixed: false + raw: VaultSecretGroup + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The relative URL of the Key Vault containing all of the certificates + in VaultCertificates. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: sourceVault + realPath: + - sourceVault + serializedName: sourceVault + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The list of key vault references in SourceVault which contain + certificates. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_41 + name: + fixed: false + name: + fixed: false + raw: vaultCertificates + realPath: + - vaultCertificates + serializedName: vaultCertificates + serializedName: VaultSecretGroup + - &ref_57 + $type: CompositeType + containsConstantProperties: false + documentation: Specifies the operating system settings for the virtual machine. + name: + fixed: false + raw: OSProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the host OS name of the virtual machine.

+ **Max-length (Windows):** 15 characters

**Max-length + (Linux):** 64 characters.

For naming conventions and + restrictions see [Azure infrastructure services implementation + guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: computerName + realPath: + - computerName + serializedName: computerName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the name of the administrator account.

+ **Windows-only restriction:** Cannot end in "."

+ **Disallowed values:** "administrator", "admin", "user", "user1", + "test", "user2", "test1", "user3", "admin1", "1", "123", "a", + "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", + "guest", "john", "owner", "root", "server", "sql", "support", + "support_388945a0", "sys", "test2", "test3", "user4", "user5". +

**Minimum-length (Linux):** 1 character

+ **Max-length (Linux):** 64 characters

**Max-length + (Windows):** 20 characters

  • For root access to the + Linux VM, see [Using root privileges on Linux virtual machines in + Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • + For a list of built-in system users on Linux that should not be used + in this field, see [Selecting User Names for Linux on + Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: adminUsername + realPath: + - adminUsername + serializedName: adminUsername + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the password of the administrator account.

    + **Minimum-length (Windows):** 8 characters

    **Minimum-length + (Linux):** 6 characters

    **Max-length (Windows):** 123 + characters

    **Max-length (Linux):** 72 characters

    + **Complexity requirements:** 3 out of 4 conditions below need to be + fulfilled
    Has lower characters
    Has upper characters
    + Has a digit
    Has a special character (Regex match [\W_]) +

    **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", + "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", + "Password22", "iloveyou!"

    For resetting the password, see + [How to reset the Remote Desktop service or its login password in a + Windows + VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) +

    For resetting root password, see [Manage users, SSH, and + check or repair disks on Azure Linux VMs using the VMAccess + Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: adminPassword + realPath: + - adminPassword + serializedName: adminPassword + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies a base-64 encoded string of custom data. The base-64 + encoded string is decoded to a binary array that is saved as a file + on the Virtual Machine. The maximum length of the binary array is + 65535 bytes.

    For using cloud-init for your VM, see [Using + cloud-init to customize a Linux VM during + creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: customData + realPath: + - customData + serializedName: customData + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies Windows operating system settings on the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_42 + name: + fixed: false + raw: windowsConfiguration + realPath: + - windowsConfiguration + serializedName: windowsConfiguration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the Linux operating system settings on the virtual + machine.

    For a list of supported Linux distributions, see + [Linux on Azure-Endorsed + Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) +

    For running non-endorsed distributions, see [Information + for Non-Endorsed + Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_43 + name: + fixed: false + raw: linuxConfiguration + realPath: + - linuxConfiguration + serializedName: linuxConfiguration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies set of certificates that should be installed onto the + virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_44 + name: + fixed: false + name: + fixed: false + raw: secrets + realPath: + - secrets + serializedName: secrets + serializedName: OSProfile + - &ref_45 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a network interface reference properties. + name: + fixed: false + raw: NetworkInterfaceReferenceProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the primary network interface in case the virtual machine + has more than 1 network interface. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: primary + realPath: + - primary + serializedName: primary + serializedName: NetworkInterfaceReferenceProperties + - &ref_46 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: Describes a network interface reference. + name: + fixed: false + raw: NetworkInterfaceReference + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_45 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: NetworkInterfaceReference + - &ref_58 + $type: CompositeType + containsConstantProperties: false + documentation: Specifies the network interfaces of the virtual machine. + name: + fixed: false + raw: NetworkProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the list of resource Ids for the network interfaces + associated with the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_46 + name: + fixed: false + name: + fixed: false + raw: networkInterfaces + realPath: + - networkInterfaces + serializedName: networkInterfaces + serializedName: NetworkProfile + - &ref_47 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Boot Diagnostics is a debugging feature which allows you to view Console + Output and Screenshot to diagnose VM status.

    For Linux Virtual + Machines, you can easily view the output of your console log.

    For + both Windows and Linux virtual machines, Azure also enables you to see a + screenshot of the VM from the hypervisor. + name: + fixed: false + raw: BootDiagnostics + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Whether boot diagnostics should be enabled on the Virtual Machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enabled + realPath: + - enabled + serializedName: enabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Uri of the storage account to use for placing the console output and + screenshot. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: storageUri + realPath: + - storageUri + serializedName: storageUri + serializedName: BootDiagnostics + - &ref_59 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Specifies the boot diagnostic settings state.

    Minimum api-version: + 2015-06-15. + name: + fixed: false + raw: DiagnosticsProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Boot Diagnostics is a debugging feature which allows you to view + Console Output and Screenshot to diagnose VM status.

    For + Linux Virtual Machines, you can easily view the output of your + console log.

    For both Windows and Linux virtual machines, + Azure also enables you to see a screenshot of the VM from the + hypervisor. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_47 + name: + fixed: false + raw: bootDiagnostics + realPath: + - bootDiagnostics + serializedName: bootDiagnostics + serializedName: DiagnosticsProfile + - &ref_48 + $type: CompositeType + containsConstantProperties: false + documentation: The instance view of a virtual machine extension handler. + name: + fixed: false + raw: VirtualMachineExtensionHandlerInstanceView + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the type of the extension; an example is + "CustomScriptExtension". + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the version of the script handler. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: typeHandlerVersion + realPath: + - typeHandlerVersion + serializedName: typeHandlerVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The extension handler status. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + serializedName: VirtualMachineExtensionHandlerInstanceView + - &ref_51 + $type: CompositeType + containsConstantProperties: false + documentation: The instance view of the VM Agent running on the virtual machine. + name: + fixed: false + raw: VirtualMachineAgentInstanceView + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The VM Agent full version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmAgentVersion + realPath: + - vmAgentVersion + serializedName: vmAgentVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine extension handler instance view. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_48 + name: + fixed: false + name: + fixed: false + raw: extensionHandlers + realPath: + - extensionHandlers + serializedName: extensionHandlers + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The resource status information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_2 + name: + fixed: false + name: + fixed: false + raw: statuses + realPath: + - statuses + serializedName: statuses + serializedName: VirtualMachineAgentInstanceView + - &ref_53 + $type: CompositeType + containsConstantProperties: false + documentation: The instance view of the disk. + name: + fixed: false + raw: DiskInstanceView + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The disk name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the encryption settings for the OS Disk.

    Minimum + api-version: 2015-06-15 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_24 + name: + fixed: false + name: + fixed: false + raw: encryptionSettings + realPath: + - encryptionSettings + serializedName: encryptionSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The resource status information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_2 + name: + fixed: false + name: + fixed: false + raw: statuses + realPath: + - statuses + serializedName: statuses + serializedName: DiskInstanceView + - &ref_54 + $type: CompositeType + containsConstantProperties: false + documentation: The instance view of a virtual machine boot diagnostics. + name: + fixed: false + raw: BootDiagnosticsInstanceView + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The console screenshot blob URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: consoleScreenshotBlobUri + realPath: + - consoleScreenshotBlobUri + serializedName: consoleScreenshotBlobUri + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Linux serial console log blob Uri. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: serialConsoleLogBlobUri + realPath: + - serialConsoleLogBlobUri + serializedName: serialConsoleLogBlobUri + serializedName: BootDiagnosticsInstanceView + - &ref_64 + $type: CompositeType + containsConstantProperties: false + documentation: Identity for the virtual machine. + name: + fixed: false + raw: VirtualMachineIdentity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The principal id of virtual machine identity. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: principalId + realPath: + - principalId + serializedName: principalId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The tenant id associated with the virtual machine. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tenantId + realPath: + - tenantId + serializedName: tenantId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The type of identity used for the virtual machine. Currently, the + only supported type is 'SystemAssigned', which implicitly creates an + identity. + extensions: + x-ms-enum: + modelAsString: false + name: ResourceIdentityType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_49 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + serializedName: VirtualMachineIdentity + - &ref_52 + $type: CompositeType + containsConstantProperties: false + documentation: Maintenance Operation Status. + name: + fixed: false + raw: MaintenanceRedeployStatus + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'True, if customer is allowed to perform Maintenance.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isCustomerInitiatedMaintenanceAllowed + realPath: + - isCustomerInitiatedMaintenanceAllowed + serializedName: isCustomerInitiatedMaintenanceAllowed + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start Time for the Pre Maintenance Window. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: preMaintenanceWindowStartTime + realPath: + - preMaintenanceWindowStartTime + serializedName: preMaintenanceWindowStartTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: End Time for the Pre Maintenance Window. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: preMaintenanceWindowEndTime + realPath: + - preMaintenanceWindowEndTime + serializedName: preMaintenanceWindowEndTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start Time for the Maintenance Window. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: maintenanceWindowStartTime + realPath: + - maintenanceWindowStartTime + serializedName: maintenanceWindowStartTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: End Time for the Maintenance Window. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: maintenanceWindowEndTime + realPath: + - maintenanceWindowEndTime + serializedName: maintenanceWindowEndTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Last Maintenance Operation Result Code. + extensions: + x-ms-enum: + modelAsString: false + name: MaintenanceOperationResultCodeTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_50 + name: + fixed: false + raw: lastOperationResultCode + realPath: + - lastOperationResultCode + serializedName: lastOperationResultCode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Message returned for the last Maintenance Operation. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: lastOperationMessage + realPath: + - lastOperationMessage + serializedName: lastOperationMessage + serializedName: MaintenanceRedeployStatus + - &ref_60 + $type: CompositeType + containsConstantProperties: false + documentation: The instance view of a virtual machine. + name: + fixed: false + raw: VirtualMachineInstanceView + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the update domain of the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: platformUpdateDomain + realPath: + - platformUpdateDomain + serializedName: platformUpdateDomain + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the fault domain of the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: platformFaultDomain + realPath: + - platformFaultDomain + serializedName: platformFaultDomain + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Remote desktop certificate thumbprint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: rdpThumbPrint + realPath: + - rdpThumbPrint + serializedName: rdpThumbPrint + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The VM Agent running on the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_51 + name: + fixed: false + raw: vmAgent + realPath: + - vmAgent + serializedName: vmAgent + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Maintenance Operation status on the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_52 + name: + fixed: false + raw: maintenanceRedeployStatus + realPath: + - maintenanceRedeployStatus + serializedName: maintenanceRedeployStatus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine disk information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_53 + name: + fixed: false + name: + fixed: false + raw: disks + realPath: + - disks + serializedName: disks + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The extensions information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_9 + name: + fixed: false + name: + fixed: false + raw: extensions + realPath: + - extensions + serializedName: extensions + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Boot Diagnostics is a debugging feature which allows you to view + Console Output and Screenshot to diagnose VM status.

    For + Linux Virtual Machines, you can easily view the output of your + console log.

    For both Windows and Linux virtual machines, + Azure also enables you to see a screenshot of the VM from the + hypervisor. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_54 + name: + fixed: false + raw: bootDiagnostics + realPath: + - bootDiagnostics + serializedName: bootDiagnostics + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The resource status information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_2 + name: + fixed: false + name: + fixed: false + raw: statuses + realPath: + - statuses + serializedName: statuses + serializedName: VirtualMachineInstanceView + - &ref_62 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of a Virtual Machine. + name: + fixed: false + raw: VirtualMachineProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the hardware settings for the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_55 + name: + fixed: false + raw: hardwareProfile + realPath: + - hardwareProfile + serializedName: hardwareProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the storage settings for the virtual machine disks. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_56 + name: + fixed: false + raw: storageProfile + realPath: + - storageProfile + serializedName: storageProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the operating system settings for the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_57 + name: + fixed: false + raw: osProfile + realPath: + - osProfile + serializedName: osProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the network interfaces of the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_58 + name: + fixed: false + raw: networkProfile + realPath: + - networkProfile + serializedName: networkProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the boot diagnostic settings state.

    Minimum + api-version: 2015-06-15. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_59 + name: + fixed: false + raw: diagnosticsProfile + realPath: + - diagnosticsProfile + serializedName: diagnosticsProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the availability set that the virtual + machine should be assigned to. Virtual machines specified in the + same availability set are allocated to different nodes to maximize + availability. For more information about availability sets, see + [Manage the availability of virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). +

    For more information on Azure planned maintainance, see + [Planned maintenance for virtual machines in + Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) +

    Currently, a VM can only be added to availability set at + creation time. An existing VM cannot be added to an availability + set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: availabilitySet + realPath: + - availabilitySet + serializedName: availabilitySet + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The provisioning state, which only appears in the response.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine instance view. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_60 + name: + fixed: false + raw: instanceView + realPath: + - instanceView + serializedName: instanceView + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies that the image or disk that is being used was licensed + on-premises. This element is only used for images that contain the + Windows Server operating system.

    Possible values are: +

    Windows_Client

    Windows_Server

    If this + element is included in a request for an update, the value must match + the initial value. This value cannot be updated.

    For more + information, see [Azure Hybrid Use Benefit for Windows + Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) +

    Minimum api-version: 2015-06-15 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: licenseType + realPath: + - licenseType + serializedName: licenseType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the VM unique ID which is a 128-bits identifier that is + encoded and stored in all Azure IaaS VMs SMBIOS and can be read + using platform BIOS commands. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmId + realPath: + - vmId + serializedName: vmId + serializedName: VirtualMachineProperties + - &ref_65 + $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + documentation: Describes a Virtual Machine. + name: + fixed: false + raw: VirtualMachine + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the marketplace image used to create the + virtual machine. This element is only used for marketplace images. + Before you can use a marketplace image from an API, you must enable + the image for programmatic use. In the Azure portal, find the + marketplace image that you want to use and then click **Want to + deploy programmatically, Get Started ->**. Enter any required + information and then click **Save**. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_61 + name: + fixed: false + raw: plan + realPath: + - plan + serializedName: plan + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_62 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine child extension resources. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_63 + name: + fixed: false + name: + fixed: false + raw: resources + realPath: + - resources + serializedName: resources + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The identity of the virtual machine, if configured.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_64 + name: + fixed: false + raw: identity + realPath: + - identity + serializedName: identity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine zones. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: zones + realPath: + - zones + serializedName: zones + serializedName: VirtualMachine + - &ref_156 + $type: CompositeType + containsConstantProperties: false + documentation: The List Virtual Machine operation response. + name: + fixed: false + raw: VirtualMachineListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of virtual machines. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_65 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The URI to fetch the next page of VMs. Call ListNext() with this URI + to fetch the next page of Virtual Machines. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: VirtualMachineListResult + - &ref_67 + $type: CompositeType + containsConstantProperties: false + documentation: The configuration parameters used while performing a rolling upgrade. + name: + fixed: false + raw: RollingUpgradePolicy + properties: + - collectionFormat: none + constraints: + InclusiveMaximum: '100' + InclusiveMinimum: '5' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The maximum percent of total virtual machine instances that will be + upgraded simultaneously by the rolling upgrade in one batch. As this + is a maximum, unhealthy instances in previous or future batches can + cause the percentage of instances in a batch to decrease to ensure + higher reliability. The default value for this parameter is 20%. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxBatchInstancePercent + realPath: + - maxBatchInstancePercent + serializedName: maxBatchInstancePercent + - collectionFormat: none + constraints: + InclusiveMaximum: '100' + InclusiveMinimum: '5' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The maximum percentage of the total virtual machine instances in the + scale set that can be simultaneously unhealthy, either as a result + of being upgraded, or by being found in an unhealthy state by the + virtual machine health checks before the rolling upgrade aborts. + This constraint will be checked prior to starting any batch. The + default value for this parameter is 20%. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxUnhealthyInstancePercent + realPath: + - maxUnhealthyInstancePercent + serializedName: maxUnhealthyInstancePercent + - collectionFormat: none + constraints: + InclusiveMaximum: '100' + InclusiveMinimum: '0' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The maximum percentage of upgraded virtual machine instances that + can be found to be in an unhealthy state. This check will happen + after each batch is upgraded. If this percentage is ever exceeded, + the rolling update aborts. The default value for this parameter is + 20%. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxUnhealthyUpgradedInstancePercent + realPath: + - maxUnhealthyUpgradedInstancePercent + serializedName: maxUnhealthyUpgradedInstancePercent + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The wait time between completing the update for all virtual machines + in one batch and starting the next batch. The time duration should + be specified in ISO 8601 format. The default value is 0 seconds + (PT0S). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pauseTimeBetweenBatches + realPath: + - pauseTimeBetweenBatches + serializedName: pauseTimeBetweenBatches + serializedName: RollingUpgradePolicy + - &ref_111 + $type: CompositeType + containsConstantProperties: false + documentation: 'Describes an upgrade policy - automatic, manual, or rolling.' + name: + fixed: false + raw: UpgradePolicy + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the mode of an upgrade to virtual machines in the scale + set.

    Possible values are:

    **Manual** - You + control the application of updates to virtual machines in the scale + set. You do this by using the manualUpgrade action.

    + **Automatic** - All virtual machines in the scale set are + automatically updated at the same time. + extensions: + x-ms-enum: + modelAsString: false + name: UpgradeMode + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_66 + name: + fixed: false + raw: mode + realPath: + - mode + serializedName: mode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The configuration parameters used while performing a rolling + upgrade. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_67 + name: + fixed: false + raw: rollingUpgradePolicy + realPath: + - rollingUpgradePolicy + serializedName: rollingUpgradePolicy + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Whether OS upgrades should automatically be applied to scale set + instances in a rolling fashion when a newer version of the image + becomes available. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: automaticOSUpgrade + realPath: + - automaticOSUpgrade + serializedName: automaticOSUpgrade + serializedName: UpgradePolicy + - &ref_69 + $type: CompositeType + containsConstantProperties: false + documentation: Describes an Operating System disk. + name: + fixed: false + raw: ImageOSDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property allows you to specify the type of the OS that is + included in the disk if creating a VM from a custom image.

    + Possible values are:

    **Windows**

    **Linux** + extensions: + x-ms-enum: + modelAsString: false + name: OperatingSystemTypes + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_11 + name: + fixed: false + raw: osType + realPath: + - osType + serializedName: osType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OS State. + extensions: + x-ms-enum: + modelAsString: false + name: OperatingSystemStateTypes + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_68 + name: + fixed: false + raw: osState + realPath: + - osState + serializedName: osState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The snapshot. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: snapshot + realPath: + - snapshot + serializedName: snapshot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The managedDisk. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: managedDisk + realPath: + - managedDisk + serializedName: managedDisk + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Virtual Hard Disk. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: blobUri + realPath: + - blobUri + serializedName: blobUri + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the caching requirements.

    Possible values are: +

    **None**

    **ReadOnly**

    **ReadWrite** +

    Default: **None for Standard storage. ReadOnly for Premium + storage** + extensions: + x-ms-enum: + modelAsString: false + name: CachingTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: caching + realPath: + - caching + serializedName: caching + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the size of empty data disks in gigabytes. This element + can be used to overwrite the name of the disk in a virtual machine + image.

    This value cannot be larger than 1023 GB + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: diskSizeGB + realPath: + - diskSizeGB + serializedName: diskSizeGB + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the storage account type for the managed disk. Possible + values are: Standard_LRS or Premium_LRS. + extensions: + x-ms-enum: + modelAsString: false + name: StorageAccountTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_23 + name: + fixed: false + raw: storageAccountType + realPath: + - storageAccountType + serializedName: storageAccountType + serializedName: ImageOSDisk + - &ref_70 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a data disk. + name: + fixed: false + raw: ImageDataDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the logical unit number of the data disk. This value is + used to identify data disks within the VM and therefore must be + unique for each data disk attached to a VM. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: lun + realPath: + - lun + serializedName: lun + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The snapshot. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: snapshot + realPath: + - snapshot + serializedName: snapshot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The managedDisk. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: managedDisk + realPath: + - managedDisk + serializedName: managedDisk + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Virtual Hard Disk. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: blobUri + realPath: + - blobUri + serializedName: blobUri + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the caching requirements.

    Possible values are: +

    **None**

    **ReadOnly**

    **ReadWrite** +

    Default: **None for Standard storage. ReadOnly for Premium + storage** + extensions: + x-ms-enum: + modelAsString: false + name: CachingTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: caching + realPath: + - caching + serializedName: caching + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the size of empty data disks in gigabytes. This element + can be used to overwrite the name of the disk in a virtual machine + image.

    This value cannot be larger than 1023 GB + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: diskSizeGB + realPath: + - diskSizeGB + serializedName: diskSizeGB + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the storage account type for the managed disk. Possible + values are: Standard_LRS or Premium_LRS. + extensions: + x-ms-enum: + modelAsString: false + name: StorageAccountTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_23 + name: + fixed: false + raw: storageAccountType + realPath: + - storageAccountType + serializedName: storageAccountType + serializedName: ImageDataDisk + - &ref_71 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a storage profile. + name: + fixed: false + raw: ImageStorageProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the operating system disk used by the + virtual machine.

    For more information about disks, see + [About disks and VHDs for Azure virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_69 + name: + fixed: false + raw: osDisk + realPath: + - osDisk + serializedName: osDisk + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the parameters that are used to add a data disk to a + virtual machine.

    For more information about disks, see + [About disks and VHDs for Azure virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_70 + name: + fixed: false + name: + fixed: false + raw: dataDisks + realPath: + - dataDisks + serializedName: dataDisks + serializedName: ImageStorageProfile + - &ref_72 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of an Image. + name: + fixed: false + raw: ImageProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The source virtual machine from which Image is created. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: sourceVirtualMachine + realPath: + - sourceVirtualMachine + serializedName: sourceVirtualMachine + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the storage settings for the virtual machine disks. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_71 + name: + fixed: false + raw: storageProfile + realPath: + - storageProfile + serializedName: storageProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The provisioning state. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + serializedName: ImageProperties + - &ref_73 + $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + documentation: >- + The source user image virtual hard disk. The virtual hard disk will be + copied before being attached to the virtual machine. If SourceImage is + provided, the destination virtual hard drive must not exist. + name: + fixed: false + raw: Image + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_72 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: Image + - &ref_151 + $type: CompositeType + containsConstantProperties: false + documentation: The List Image operation response. + name: + fixed: false + raw: ImageListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of Images. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_73 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The uri to fetch the next page of Images. Call ListNext() with this + to fetch the next page of Images. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ImageListResult + - &ref_115 + $type: CompositeType + containsConstantProperties: false + documentation: Identity for the virtual machine scale set. + name: + fixed: false + raw: VirtualMachineScaleSetIdentity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The principal id of virtual machine scale set identity. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: principalId + realPath: + - principalId + serializedName: principalId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The tenant id associated with the virtual machine scale set. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tenantId + realPath: + - tenantId + serializedName: tenantId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The type of identity used for the virtual machine scale set. + Currently, the only supported type is 'SystemAssigned', which + implicitly creates an identity. + extensions: + x-ms-enum: + modelAsString: false + name: ResourceIdentityType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_49 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + serializedName: VirtualMachineScaleSetIdentity + - &ref_77 + $type: CompositeType + containsConstantProperties: false + documentation: Describes scaling information of a SKU. + name: + fixed: false + raw: ResourceSkuCapacity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The minimum capacity. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: minimum + realPath: + - minimum + serializedName: minimum + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The maximum capacity that can be set. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: maximum + realPath: + - maximum + serializedName: maximum + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The default capacity. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: default + realPath: + - default + serializedName: default + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The scale type applicable to the sku. + extensions: + x-ms-enum: + modelAsString: false + name: ResourceSkuCapacityScaleType + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_74 + name: + fixed: false + raw: scaleType + realPath: + - scaleType + serializedName: scaleType + serializedName: ResourceSkuCapacity + - &ref_78 + $type: CompositeType + containsConstantProperties: false + documentation: Describes metadata for retrieving price info. + name: + fixed: false + raw: ResourceSkuCosts + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Used for querying price from commerce. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: meterID + realPath: + - meterID + serializedName: meterID + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The multiplier is needed to extend the base metered cost. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: quantity + realPath: + - quantity + serializedName: quantity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An invariant to show the extended unit. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: extendedUnit + realPath: + - extendedUnit + serializedName: extendedUnit + serializedName: ResourceSkuCosts + - &ref_79 + $type: CompositeType + containsConstantProperties: false + documentation: Describes The SKU capabilites object. + name: + fixed: false + raw: ResourceSkuCapabilities + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An invariant to describe the feature. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An invariant if the feature is measured by quantity. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: ResourceSkuCapabilities + - &ref_80 + $type: CompositeType + containsConstantProperties: false + documentation: Describes scaling information of a SKU. + name: + fixed: false + raw: ResourceSkuRestrictions + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The type of restrictions. + extensions: + x-ms-enum: + modelAsString: false + name: ResourceSkuRestrictionsType + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_75 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The value of restrictions. If the restriction type is set to + location. This would be different locations where the SKU is + restricted. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: values + realPath: + - values + serializedName: values + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The reason for restriction. + extensions: + x-ms-enum: + modelAsString: false + name: ResourceSkuRestrictionsReasonCode + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_76 + name: + fixed: false + raw: reasonCode + realPath: + - reasonCode + serializedName: reasonCode + serializedName: ResourceSkuRestrictions + - &ref_81 + $type: CompositeType + containsConstantProperties: false + documentation: Describes an available Compute SKU. + name: + fixed: false + raw: ResourceSku + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The type of resource the SKU applies to. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceType + realPath: + - resourceType + serializedName: resourceType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of SKU. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the tier of virtual machines in a scale set.

    + Possible Values:

    **Standard**

    **Basic** + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tier + realPath: + - tier + serializedName: tier + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Size of the SKU. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: size + realPath: + - size + serializedName: size + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Family of this particular SKU. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: family + realPath: + - family + serializedName: family + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Kind of resources that are supported in this SKU. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: kind + realPath: + - kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the number of virtual machines in the scale set. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_77 + name: + fixed: false + raw: capacity + realPath: + - capacity + serializedName: capacity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The set of locations that the SKU is available. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: locations + realPath: + - locations + serializedName: locations + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The api versions that support this SKU. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: apiVersions + realPath: + - apiVersions + serializedName: apiVersions + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Metadata for retrieving price info. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_78 + name: + fixed: false + name: + fixed: false + raw: costs + realPath: + - costs + serializedName: costs + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A name value pair to describe the capability. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_79 + name: + fixed: false + name: + fixed: false + raw: capabilities + realPath: + - capabilities + serializedName: capabilities + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The restrictions because of which SKU cannot be used. This is empty + if there are no restrictions. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_80 + name: + fixed: false + name: + fixed: false + raw: restrictions + realPath: + - restrictions + serializedName: restrictions + serializedName: ResourceSku + - &ref_152 + $type: CompositeType + containsConstantProperties: false + documentation: The Compute List Skus operation response. + name: + fixed: false + raw: ResourceSkusResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of skus available for the subscription. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_81 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The uri to fetch the next page of Compute Skus. Call ListNext() with + this to fetch the next page of VMSS Skus. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ResourceSkusResult + - &ref_104 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set OS profile. + name: + fixed: false + raw: VirtualMachineScaleSetOSProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the computer name prefix for all of the virtual machines + in the scale set. Computer name prefixes must be 1 to 15 characters + long. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: computerNamePrefix + realPath: + - computerNamePrefix + serializedName: computerNamePrefix + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the name of the administrator account.

    + **Windows-only restriction:** Cannot end in "."

    + **Disallowed values:** "administrator", "admin", "user", "user1", + "test", "user2", "test1", "user3", "admin1", "1", "123", "a", + "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", + "guest", "john", "owner", "root", "server", "sql", "support", + "support_388945a0", "sys", "test2", "test3", "user4", "user5". +

    **Minimum-length (Linux):** 1 character

    + **Max-length (Linux):** 64 characters

    **Max-length + (Windows):** 20 characters

  • For root access to the + Linux VM, see [Using root privileges on Linux virtual machines in + Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • + For a list of built-in system users on Linux that should not be used + in this field, see [Selecting User Names for Linux on + Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: adminUsername + realPath: + - adminUsername + serializedName: adminUsername + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the password of the administrator account.

    + **Minimum-length (Windows):** 8 characters

    **Minimum-length + (Linux):** 6 characters

    **Max-length (Windows):** 123 + characters

    **Max-length (Linux):** 72 characters

    + **Complexity requirements:** 3 out of 4 conditions below need to be + fulfilled
    Has lower characters
    Has upper characters
    + Has a digit
    Has a special character (Regex match [\W_]) +

    **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", + "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", + "Password22", "iloveyou!"

    For resetting the password, see + [How to reset the Remote Desktop service or its login password in a + Windows + VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) +

    For resetting root password, see [Manage users, SSH, and + check or repair disks on Azure Linux VMs using the VMAccess + Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: adminPassword + realPath: + - adminPassword + serializedName: adminPassword + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies a base-64 encoded string of custom data. The base-64 + encoded string is decoded to a binary array that is saved as a file + on the Virtual Machine. The maximum length of the binary array is + 65535 bytes.

    For using cloud-init for your VM, see [Using + cloud-init to customize a Linux VM during + creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: customData + realPath: + - customData + serializedName: customData + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies Windows operating system settings on the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_42 + name: + fixed: false + raw: windowsConfiguration + realPath: + - windowsConfiguration + serializedName: windowsConfiguration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the Linux operating system settings on the virtual + machine.

    For a list of supported Linux distributions, see + [Linux on Azure-Endorsed + Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) +

    For running non-endorsed distributions, see [Information + for Non-Endorsed + Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_43 + name: + fixed: false + raw: linuxConfiguration + realPath: + - linuxConfiguration + serializedName: linuxConfiguration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies set of certificates that should be installed onto the + virtual machines in the scale set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_44 + name: + fixed: false + name: + fixed: false + raw: secrets + realPath: + - secrets + serializedName: secrets + serializedName: VirtualMachineScaleSetOSProfile + - &ref_108 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set OS profile. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateOSProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A base-64 encoded string of custom data. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: customData + realPath: + - customData + serializedName: customData + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Windows Configuration of the OS profile. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_42 + name: + fixed: false + raw: windowsConfiguration + realPath: + - windowsConfiguration + serializedName: windowsConfiguration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Linux Configuration of the OS profile. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_43 + name: + fixed: false + raw: linuxConfiguration + realPath: + - linuxConfiguration + serializedName: linuxConfiguration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The List of certificates for addition to the VM. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_44 + name: + fixed: false + name: + fixed: false + raw: secrets + realPath: + - secrets + serializedName: secrets + serializedName: VirtualMachineScaleSetUpdateOSProfile + - &ref_82 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the parameters of a ScaleSet managed disk. + name: + fixed: false + raw: VirtualMachineScaleSetManagedDiskParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the storage account type for the managed disk. Possible + values are: Standard_LRS or Premium_LRS. + extensions: + x-ms-enum: + modelAsString: false + name: StorageAccountTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_23 + name: + fixed: false + raw: storageAccountType + realPath: + - storageAccountType + serializedName: storageAccountType + serializedName: VirtualMachineScaleSetManagedDiskParameters + - &ref_83 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set operating system disk. + name: + fixed: false + raw: VirtualMachineScaleSetOSDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The disk name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the caching requirements.

    Possible values are: +

    **None**

    **ReadOnly**

    **ReadWrite** +

    Default: **None for Standard storage. ReadOnly for Premium + storage** + extensions: + x-ms-enum: + modelAsString: false + name: CachingTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: caching + realPath: + - caching + serializedName: caching + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies how the virtual machines in the scale set should be + created.

    The only allowed value is: **FromImage** \u2013 + This value is used when you are using an image to create the virtual + machine. If you are using a platform image, you also use the + imageReference element described above. If you are using a + marketplace image, you also use the plan element previously + described. + extensions: + x-ms-enum: + modelAsString: false + name: DiskCreateOptionTypes + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_27 + name: + fixed: false + raw: createOption + realPath: + - createOption + serializedName: createOption + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + This property allows you to specify the type of the OS that is + included in the disk if creating a VM from user-image or a + specialized VHD.

    Possible values are:

    **Windows** +

    **Linux** + extensions: + x-ms-enum: + modelAsString: false + name: OperatingSystemTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_11 + name: + fixed: false + raw: osType + realPath: + - osType + serializedName: osType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the unmanaged user image to base the + scale set on. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_25 + name: + fixed: false + raw: image + realPath: + - image + serializedName: image + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the container urls that are used to store operating system + disks for the scale set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: vhdContainers + realPath: + - vhdContainers + serializedName: vhdContainers + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The managed disk parameters. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_82 + name: + fixed: false + raw: managedDisk + realPath: + - managedDisk + serializedName: managedDisk + serializedName: VirtualMachineScaleSetOSDisk + - &ref_85 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes virtual machine scale set operating system disk Update Object. + This should be used for Updating VMSS OS Disk. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateOSDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The caching type. + extensions: + x-ms-enum: + modelAsString: false + name: CachingTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: caching + realPath: + - caching + serializedName: caching + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Source User Image VirtualHardDisk. This VirtualHardDisk will be + copied before using it to attach to the Virtual Machine. If + SourceImage is provided, the destination VirtualHardDisk should not + exist. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_25 + name: + fixed: false + raw: image + realPath: + - image + serializedName: image + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of virtual hard disk container uris. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: vhdContainers + realPath: + - vhdContainers + serializedName: vhdContainers + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The managed disk parameters. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_82 + name: + fixed: false + raw: managedDisk + realPath: + - managedDisk + serializedName: managedDisk + serializedName: VirtualMachineScaleSetUpdateOSDisk + - &ref_84 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set data disk. + name: + fixed: false + raw: VirtualMachineScaleSetDataDisk + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The disk name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the logical unit number of the data disk. This value is + used to identify data disks within the VM and therefore must be + unique for each data disk attached to a VM. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: lun + realPath: + - lun + serializedName: lun + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the caching requirements.

    Possible values are: +

    **None**

    **ReadOnly**

    **ReadWrite** +

    Default: **None for Standard storage. ReadOnly for Premium + storage** + extensions: + x-ms-enum: + modelAsString: false + name: CachingTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: caching + realPath: + - caching + serializedName: caching + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The create option. + extensions: + x-ms-enum: + modelAsString: false + name: DiskCreateOptionTypes + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_27 + name: + fixed: false + raw: createOption + realPath: + - createOption + serializedName: createOption + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the size of an empty data disk in gigabytes. This element + can be used to overwrite the name of the disk in a virtual machine + image.

    This value cannot be larger than 1023 GB + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: diskSizeGB + realPath: + - diskSizeGB + serializedName: diskSizeGB + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The managed disk parameters. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_82 + name: + fixed: false + raw: managedDisk + realPath: + - managedDisk + serializedName: managedDisk + serializedName: VirtualMachineScaleSetDataDisk + - &ref_105 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set storage profile. + name: + fixed: false + raw: VirtualMachineScaleSetStorageProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the image to use. You can specify + information about platform images, marketplace images, or virtual + machine images. This element is required when you want to use a + platform image, marketplace image, or virtual machine image, but is + not used in other creation operations. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_29 + name: + fixed: false + raw: imageReference + realPath: + - imageReference + serializedName: imageReference + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the operating system disk used by the + virtual machines in the scale set.

    For more information + about disks, see [About disks and VHDs for Azure virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_83 + name: + fixed: false + raw: osDisk + realPath: + - osDisk + serializedName: osDisk + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the parameters that are used to add data disks to the + virtual machines in the scale set.

    For more information + about disks, see [About disks and VHDs for Azure virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_84 + name: + fixed: false + name: + fixed: false + raw: dataDisks + realPath: + - dataDisks + serializedName: dataDisks + serializedName: VirtualMachineScaleSetStorageProfile + - &ref_109 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set storage profile. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateStorageProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The image reference. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_29 + name: + fixed: false + raw: imageReference + realPath: + - imageReference + serializedName: imageReference + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OS disk. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_85 + name: + fixed: false + raw: osDisk + realPath: + - osDisk + serializedName: osDisk + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The data disks. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_84 + name: + fixed: false + name: + fixed: false + raw: dataDisks + realPath: + - dataDisks + serializedName: dataDisks + serializedName: VirtualMachineScaleSetUpdateStorageProfile + - &ref_88 + $type: CompositeType + containsConstantProperties: false + documentation: The API entity reference. + name: + fixed: false + raw: ApiEntityReference + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ARM resource id in the form of + /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: ApiEntityReference + - &ref_86 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a virtual machines scale sets network configuration's DNS + settings. + name: + fixed: false + raw: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Domain name label.The concatenation of the domain name label and + vm index will be the domain name labels of the PublicIPAddress + resources that will be created + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainNameLabel + realPath: + - domainNameLabel + serializedName: domainNameLabel + serializedName: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings + - &ref_87 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a virtual machines scale set IP Configuration's PublicIPAddress + configuration + name: + fixed: false + raw: VirtualMachineScaleSetPublicIPAddressConfigurationProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The idle timeout of the public IP address. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: idleTimeoutInMinutes + realPath: + - idleTimeoutInMinutes + serializedName: idleTimeoutInMinutes + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The dns settings to be applied on the publicIP addresses . + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_86 + name: + fixed: false + raw: dnsSettings + realPath: + - dnsSettings + serializedName: dnsSettings + serializedName: VirtualMachineScaleSetPublicIPAddressConfigurationProperties + - &ref_89 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a virtual machines scale set IP Configuration's PublicIPAddress + configuration + name: + fixed: false + raw: VirtualMachineScaleSetPublicIPAddressConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The publicIP address configuration name. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_87 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineScaleSetPublicIPAddressConfiguration + - &ref_93 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a virtual machine scale set network profile's IP configuration + properties. + name: + fixed: false + raw: VirtualMachineScaleSetIPConfigurationProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the identifier of the subnet. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_88 + name: + fixed: false + raw: subnet + realPath: + - subnet + serializedName: subnet + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the primary network interface in case the virtual machine + has more than 1 network interface. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: primary + realPath: + - primary + serializedName: primary + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The publicIPAddressConfiguration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_89 + name: + fixed: false + raw: publicIPAddressConfiguration + realPath: + - publicIPAddressConfiguration + serializedName: publicIPAddressConfiguration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Available from Api-Version 2017-03-30 onwards, it represents whether + the specific ipconfiguration is IPv4 or IPv6. Default is taken as + IPv4. Possible values are: 'IPv4' and 'IPv6'. + extensions: + x-ms-enum: + modelAsString: true + name: IPVersion + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_90 + name: + fixed: false + raw: privateIPAddressVersion + realPath: + - privateIPAddressVersion + serializedName: privateIPAddressVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies an array of references to backend address pools of + application gateways. A scale set can reference backend address + pools of multiple application gateways. Multiple scale sets cannot + use the same application gateway. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: applicationGatewayBackendAddressPools + realPath: + - applicationGatewayBackendAddressPools + serializedName: applicationGatewayBackendAddressPools + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies an array of references to backend address pools of load + balancers. A scale set can reference backend address pools of one + public and one internal load balancer. Multiple scale sets cannot + use the same load balancer. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: loadBalancerBackendAddressPools + realPath: + - loadBalancerBackendAddressPools + serializedName: loadBalancerBackendAddressPools + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies an array of references to inbound Nat pools of the load + balancers. A scale set can reference inbound nat pools of one public + and one internal load balancer. Multiple scale sets cannot use the + same load balancer + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: loadBalancerInboundNatPools + realPath: + - loadBalancerInboundNatPools + serializedName: loadBalancerInboundNatPools + serializedName: VirtualMachineScaleSetIPConfigurationProperties + - &ref_91 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a virtual machines scale set IP Configuration's PublicIPAddress + configuration + name: + fixed: false + raw: VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The idle timeout of the public IP address. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: idleTimeoutInMinutes + realPath: + - idleTimeoutInMinutes + serializedName: idleTimeoutInMinutes + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The dns settings to be applied on the publicIP addresses . + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_86 + name: + fixed: false + raw: dnsSettings + realPath: + - dnsSettings + serializedName: dnsSettings + serializedName: VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties + - &ref_92 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a virtual machines scale set IP Configuration's PublicIPAddress + configuration + name: + fixed: false + raw: VirtualMachineScaleSetUpdatePublicIPAddressConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The publicIP address configuration name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_91 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineScaleSetUpdatePublicIPAddressConfiguration + - &ref_94 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a virtual machine scale set network profile's IP configuration + properties. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateIPConfigurationProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The subnet. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_88 + name: + fixed: false + raw: subnet + realPath: + - subnet + serializedName: subnet + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the primary IP Configuration in case the network interface + has more than one IP Configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: primary + realPath: + - primary + serializedName: primary + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The publicIPAddressConfiguration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_92 + name: + fixed: false + raw: publicIPAddressConfiguration + realPath: + - publicIPAddressConfiguration + serializedName: publicIPAddressConfiguration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Available from Api-Version 2017-03-30 onwards, it represents whether + the specific ipconfiguration is IPv4 or IPv6. Default is taken as + IPv4. Possible values are: 'IPv4' and 'IPv6'. + extensions: + x-ms-enum: + modelAsString: true + name: IPVersion + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_90 + name: + fixed: false + raw: privateIPAddressVersion + realPath: + - privateIPAddressVersion + serializedName: privateIPAddressVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The application gateway backend address pools. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: applicationGatewayBackendAddressPools + realPath: + - applicationGatewayBackendAddressPools + serializedName: applicationGatewayBackendAddressPools + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The load balancer backend address pools. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: loadBalancerBackendAddressPools + realPath: + - loadBalancerBackendAddressPools + serializedName: loadBalancerBackendAddressPools + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The load balancer inbound nat pools. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_1 + name: + fixed: false + name: + fixed: false + raw: loadBalancerInboundNatPools + realPath: + - loadBalancerInboundNatPools + serializedName: loadBalancerInboundNatPools + serializedName: VirtualMachineScaleSetUpdateIPConfigurationProperties + - &ref_96 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: Describes a virtual machine scale set network profile's IP configuration. + name: + fixed: false + raw: VirtualMachineScaleSetIPConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The IP configuration name. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_93 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineScaleSetIPConfiguration + - &ref_97 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: Describes a virtual machine scale set network profile's IP configuration. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateIPConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The IP configuration name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_94 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineScaleSetUpdateIPConfiguration + - &ref_95 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a virtual machines scale sets network configuration's DNS + settings. + name: + fixed: false + raw: VirtualMachineScaleSetNetworkConfigurationDnsSettings + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of DNS servers IP addresses + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: dnsServers + realPath: + - dnsServers + serializedName: dnsServers + serializedName: VirtualMachineScaleSetNetworkConfigurationDnsSettings + - &ref_98 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set network profile's IP configuration. + name: + fixed: false + raw: VirtualMachineScaleSetNetworkConfigurationProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the primary network interface in case the virtual machine + has more than 1 network interface. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: primary + realPath: + - primary + serializedName: primary + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies whether the network interface is accelerated + networking-enabled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableAcceleratedNetworking + realPath: + - enableAcceleratedNetworking + serializedName: enableAcceleratedNetworking + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The network security group. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: networkSecurityGroup + realPath: + - networkSecurityGroup + serializedName: networkSecurityGroup + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The dns settings to be applied on the network interfaces. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_95 + name: + fixed: false + raw: dnsSettings + realPath: + - dnsSettings + serializedName: dnsSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the IP configurations of the network interface. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_96 + name: + fixed: false + name: + fixed: false + raw: ipConfigurations + realPath: + - ipConfigurations + serializedName: ipConfigurations + serializedName: VirtualMachineScaleSetNetworkConfigurationProperties + - &ref_99 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Describes a virtual machine scale set updatable network profile's IP + configuration.Use this object for updating network profile's IP + Configuration. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateNetworkConfigurationProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Whether this is a primary NIC on a virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: primary + realPath: + - primary + serializedName: primary + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies whether the network interface is accelerated + networking-enabled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enableAcceleratedNetworking + realPath: + - enableAcceleratedNetworking + serializedName: enableAcceleratedNetworking + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The network security group. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: networkSecurityGroup + realPath: + - networkSecurityGroup + serializedName: networkSecurityGroup + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The dns settings to be applied on the network interfaces. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_95 + name: + fixed: false + raw: dnsSettings + realPath: + - dnsSettings + serializedName: dnsSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set IP Configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_97 + name: + fixed: false + name: + fixed: false + raw: ipConfigurations + realPath: + - ipConfigurations + serializedName: ipConfigurations + serializedName: VirtualMachineScaleSetUpdateNetworkConfigurationProperties + - &ref_100 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: >- + Describes a virtual machine scale set network profile's network + configurations. + name: + fixed: false + raw: VirtualMachineScaleSetNetworkConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The network configuration name. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_98 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineScaleSetNetworkConfiguration + - &ref_101 + $type: CompositeType + baseModelType: *ref_1 + containsConstantProperties: false + documentation: >- + Describes a virtual machine scale set network profile's network + configurations. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateNetworkConfiguration + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The network configuration name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_99 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineScaleSetUpdateNetworkConfiguration + - &ref_106 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set network profile. + name: + fixed: false + raw: VirtualMachineScaleSetNetworkProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A reference to a load balancer probe used to determine the health of + an instance in the virtual machine scale set. The reference will be + in the form: + '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_88 + name: + fixed: false + raw: healthProbe + realPath: + - healthProbe + serializedName: healthProbe + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of network configurations. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_100 + name: + fixed: false + name: + fixed: false + raw: networkInterfaceConfigurations + realPath: + - networkInterfaceConfigurations + serializedName: networkInterfaceConfigurations + serializedName: VirtualMachineScaleSetNetworkProfile + - &ref_110 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set network profile. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateNetworkProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of network configurations. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_101 + name: + fixed: false + name: + fixed: false + raw: networkInterfaceConfigurations + realPath: + - networkInterfaceConfigurations + serializedName: networkInterfaceConfigurations + serializedName: VirtualMachineScaleSetUpdateNetworkProfile + - &ref_102 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of a Virtual Machine Scale Set Extension. + name: + fixed: false + raw: VirtualMachineScaleSetExtensionProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If a value is provided and is different from the previous value, the + extension handler will be forced to update even if the extension + configuration has not changed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: forceUpdateTag + realPath: + - forceUpdateTag + serializedName: forceUpdateTag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the extension handler publisher. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisher + realPath: + - publisher + serializedName: publisher + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the type of the extension; an example is + "CustomScriptExtension". + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the version of the script handler. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: typeHandlerVersion + realPath: + - typeHandlerVersion + serializedName: typeHandlerVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Indicates whether the extension should use a newer minor version if + one is available at deployment time. Once deployed, however, the + extension will not upgrade minor versions unless redeployed, even + with this property set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: autoUpgradeMinorVersion + realPath: + - autoUpgradeMinorVersion + serializedName: autoUpgradeMinorVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Json formatted public settings for the extension. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: settings + realPath: + - settings + serializedName: settings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The extension can contain either protectedSettings or + protectedSettingsFromKeyVault or no protected settings at all. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: protectedSettings + realPath: + - protectedSettings + serializedName: protectedSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The provisioning state, which only appears in the response.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + serializedName: VirtualMachineScaleSetExtensionProperties + - &ref_103 + $type: CompositeType + baseModelType: &ref_136 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: SubResourceReadOnly + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: SubResourceReadOnly + containsConstantProperties: false + documentation: Describes a Virtual Machine Scale Set Extension. + name: + fixed: false + raw: VirtualMachineScaleSetExtension + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the extension. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_102 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VirtualMachineScaleSetExtension + - &ref_164 + $type: CompositeType + containsConstantProperties: false + documentation: The List VM scale set extension operation response. + name: + fixed: false + raw: VirtualMachineScaleSetExtensionListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of VM scale set extensions. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_103 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The uri to fetch the next page of VM scale set extensions. Call + ListNext() with this to fetch the next page of VM scale set + extensions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: VirtualMachineScaleSetExtensionListResult + - &ref_107 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set extension profile. + name: + fixed: false + raw: VirtualMachineScaleSetExtensionProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set child extension resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_103 + name: + fixed: false + name: + fixed: false + raw: extensions + realPath: + - extensions + serializedName: extensions + serializedName: VirtualMachineScaleSetExtensionProfile + - &ref_112 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set virtual machine profile. + name: + fixed: false + raw: VirtualMachineScaleSetVMProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the operating system settings for the virtual machines in + the scale set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_104 + name: + fixed: false + raw: osProfile + realPath: + - osProfile + serializedName: osProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the storage settings for the virtual machine disks. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_105 + name: + fixed: false + raw: storageProfile + realPath: + - storageProfile + serializedName: storageProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies properties of the network interfaces of the virtual + machines in the scale set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_106 + name: + fixed: false + raw: networkProfile + realPath: + - networkProfile + serializedName: networkProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the boot diagnostic settings state.

    Minimum + api-version: 2015-06-15. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_59 + name: + fixed: false + raw: diagnosticsProfile + realPath: + - diagnosticsProfile + serializedName: diagnosticsProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies a collection of settings for extensions installed on + virtual machines in the scale set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_107 + name: + fixed: false + raw: extensionProfile + realPath: + - extensionProfile + serializedName: extensionProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies that the image or disk that is being used was licensed + on-premises. This element is only used for images that contain the + Windows Server operating system.

    Possible values are: +

    Windows_Client

    Windows_Server

    If this + element is included in a request for an update, the value must match + the initial value. This value cannot be updated.

    For more + information, see [Azure Hybrid Use Benefit for Windows + Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) +

    Minimum api-version: 2015-06-15 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: licenseType + realPath: + - licenseType + serializedName: licenseType + serializedName: VirtualMachineScaleSetVMProfile + - &ref_113 + $type: CompositeType + containsConstantProperties: false + documentation: Describes a virtual machine scale set virtual machine profile. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateVMProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set OS profile. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_108 + name: + fixed: false + raw: osProfile + realPath: + - osProfile + serializedName: osProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set storage profile. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_109 + name: + fixed: false + raw: storageProfile + realPath: + - storageProfile + serializedName: storageProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set network profile. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_110 + name: + fixed: false + raw: networkProfile + realPath: + - networkProfile + serializedName: networkProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set diagnostics profile. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_59 + name: + fixed: false + raw: diagnosticsProfile + realPath: + - diagnosticsProfile + serializedName: diagnosticsProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set extension profile. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_107 + name: + fixed: false + raw: extensionProfile + realPath: + - extensionProfile + serializedName: extensionProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The license type, which is for bring your own license scenario.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: licenseType + realPath: + - licenseType + serializedName: licenseType + serializedName: VirtualMachineScaleSetUpdateVMProfile + - &ref_114 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of a Virtual Machine Scale Set. + name: + fixed: false + raw: VirtualMachineScaleSetProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The upgrade policy. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_111 + name: + fixed: false + raw: upgradePolicy + realPath: + - upgradePolicy + serializedName: upgradePolicy + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine profile. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_112 + name: + fixed: false + raw: virtualMachineProfile + realPath: + - virtualMachineProfile + serializedName: virtualMachineProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The provisioning state, which only appears in the response.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies whether the Virtual Machine Scale Set should be + overprovisioned. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: overprovision + realPath: + - overprovision + serializedName: overprovision + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the ID which uniquely identifies a Virtual Machine Scale + Set. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: uniqueId + realPath: + - uniqueId + serializedName: uniqueId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When true this limits the scale set to a single placement group, of + max size 100 virtual machines. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: singlePlacementGroup + realPath: + - singlePlacementGroup + serializedName: singlePlacementGroup + serializedName: VirtualMachineScaleSetProperties + - &ref_116 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of a Virtual Machine Scale Set. + name: + fixed: false + raw: VirtualMachineScaleSetUpdateProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The upgrade policy. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_111 + name: + fixed: false + raw: upgradePolicy + realPath: + - upgradePolicy + serializedName: upgradePolicy + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine profile. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_113 + name: + fixed: false + raw: virtualMachineProfile + realPath: + - virtualMachineProfile + serializedName: virtualMachineProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies whether the Virtual Machine Scale Set should be + overprovisioned. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: overprovision + realPath: + - overprovision + serializedName: overprovision + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When true this limits the scale set to a single placement group, of + max size 100 virtual machines. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: singlePlacementGroup + realPath: + - singlePlacementGroup + serializedName: singlePlacementGroup + serializedName: VirtualMachineScaleSetUpdateProperties + - &ref_120 + $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + documentation: Describes a Virtual Machine Scale Set. + name: + fixed: false + raw: VirtualMachineScaleSet + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set sku. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_4 + name: + fixed: false + raw: sku + realPath: + - sku + serializedName: sku + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the marketplace image used to create the + virtual machine. This element is only used for marketplace images. + Before you can use a marketplace image from an API, you must enable + the image for programmatic use. In the Azure portal, find the + marketplace image that you want to use and then click **Want to + deploy programmatically, Get Started ->**. Enter any required + information and then click **Save**. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_61 + name: + fixed: false + raw: plan + realPath: + - plan + serializedName: plan + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_114 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The identity of the virtual machine scale set, if configured.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_115 + name: + fixed: false + raw: identity + realPath: + - identity + serializedName: identity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set zones. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: zones + realPath: + - zones + serializedName: zones + serializedName: VirtualMachineScaleSet + - &ref_157 + $type: CompositeType + baseModelType: &ref_135 + $type: CompositeType + containsConstantProperties: false + documentation: The Update Resource model definition. + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: UpdateResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource tags + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + serializedName: UpdateResource + containsConstantProperties: false + documentation: Describes a Virtual Machine Scale Set. + name: + fixed: false + raw: VirtualMachineScaleSetUpdate + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set sku. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_4 + name: + fixed: false + raw: sku + realPath: + - sku + serializedName: sku + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The purchase plan when deploying a virtual machine scale set from VM + Marketplace images. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_61 + name: + fixed: false + raw: plan + realPath: + - plan + serializedName: plan + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_116 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The identity of the virtual machine scale set, if configured.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_115 + name: + fixed: false + raw: identity + realPath: + - identity + serializedName: identity + serializedName: VirtualMachineScaleSetUpdate + - &ref_158 + $type: CompositeType + containsConstantProperties: false + documentation: Specifies a list of virtual machine instance IDs from the VM scale set. + name: + fixed: false + raw: VirtualMachineScaleSetVMInstanceIDs + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The virtual machine scale set instance ids. Omitting the virtual + machine scale set instance ids will result in the operation being + performed on all virtual machines in the virtual machine scale set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: instanceIds + realPath: + - instanceIds + serializedName: instanceIds + serializedName: VirtualMachineScaleSetVMInstanceIDs + - &ref_159 + $type: CompositeType + containsConstantProperties: false + documentation: Specifies a list of virtual machine instance IDs from the VM scale set. + name: + fixed: false + raw: VirtualMachineScaleSetVMInstanceRequiredIDs + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine scale set instance ids. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: instanceIds + realPath: + - instanceIds + serializedName: instanceIds + serializedName: VirtualMachineScaleSetVMInstanceRequiredIDs + - &ref_117 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The status code and count of the virtual machine scale set instance view + status summary. + name: + fixed: false + raw: VirtualMachineStatusCodeCount + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance view status code. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The number of instances having a particular status code. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: count + realPath: + - count + serializedName: count + serializedName: VirtualMachineStatusCodeCount + - &ref_118 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Instance view statuses summary for virtual machines of a virtual machine + scale set. + name: + fixed: false + raw: VirtualMachineScaleSetInstanceViewStatusesSummary + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The extensions information. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_117 + name: + fixed: false + name: + fixed: false + raw: statusesSummary + realPath: + - statusesSummary + serializedName: statusesSummary + serializedName: VirtualMachineScaleSetInstanceViewStatusesSummary + - &ref_119 + $type: CompositeType + containsConstantProperties: false + documentation: Extensions summary for virtual machines of a virtual machine scale set. + name: + fixed: false + raw: VirtualMachineScaleSetVMExtensionsSummary + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The extension name. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The extensions information. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_117 + name: + fixed: false + name: + fixed: false + raw: statusesSummary + realPath: + - statusesSummary + serializedName: statusesSummary + serializedName: VirtualMachineScaleSetVMExtensionsSummary + - &ref_160 + $type: CompositeType + containsConstantProperties: false + documentation: The instance view of a virtual machine scale set. + name: + fixed: false + raw: VirtualMachineScaleSetInstanceView + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance view status summary for the virtual machine scale set. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_118 + name: + fixed: false + raw: virtualMachine + realPath: + - virtualMachine + serializedName: virtualMachine + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The extensions information. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_119 + name: + fixed: false + name: + fixed: false + raw: extensions + realPath: + - extensions + serializedName: extensions + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The resource status information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_2 + name: + fixed: false + name: + fixed: false + raw: statuses + realPath: + - statuses + serializedName: statuses + serializedName: VirtualMachineScaleSetInstanceView + - &ref_161 + $type: CompositeType + containsConstantProperties: false + documentation: The List Virtual Machine operation response. + name: + fixed: false + raw: VirtualMachineScaleSetListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of virtual machine scale sets. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_120 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The uri to fetch the next page of Virtual Machine Scale Sets. Call + ListNext() with this to fetch the next page of VMSS. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: VirtualMachineScaleSetListResult + - &ref_162 + $type: CompositeType + containsConstantProperties: false + documentation: The List Virtual Machine operation response. + name: + fixed: false + raw: VirtualMachineScaleSetListWithLinkResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of virtual machine scale sets. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_120 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The uri to fetch the next page of Virtual Machine Scale Sets. Call + ListNext() with this to fetch the next page of Virtual Machine Scale + Sets. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: VirtualMachineScaleSetListWithLinkResult + - &ref_122 + $type: CompositeType + containsConstantProperties: false + documentation: Describes scaling information of a sku. + name: + fixed: false + raw: VirtualMachineScaleSetSkuCapacity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The minimum capacity. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: minimum + realPath: + - minimum + serializedName: minimum + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The maximum capacity that can be set. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: maximum + realPath: + - maximum + serializedName: maximum + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The default capacity. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: defaultCapacity + realPath: + - defaultCapacity + serializedName: defaultCapacity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The scale type applicable to the sku. + extensions: + x-ms-enum: + modelAsString: false + name: VirtualMachineScaleSetSkuScaleType + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_121 + name: + fixed: false + raw: scaleType + realPath: + - scaleType + serializedName: scaleType + serializedName: VirtualMachineScaleSetSkuCapacity + - &ref_123 + $type: CompositeType + containsConstantProperties: false + documentation: Describes an available virtual machine scale set sku. + name: + fixed: false + raw: VirtualMachineScaleSetSku + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The type of resource the sku applies to. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceType + realPath: + - resourceType + serializedName: resourceType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Sku. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_4 + name: + fixed: false + raw: sku + realPath: + - sku + serializedName: sku + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the number of virtual machines in the scale set. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_122 + name: + fixed: false + raw: capacity + realPath: + - capacity + serializedName: capacity + serializedName: VirtualMachineScaleSetSku + - &ref_163 + $type: CompositeType + containsConstantProperties: false + documentation: The Virtual Machine Scale Set List Skus operation response. + name: + fixed: false + raw: VirtualMachineScaleSetListSkusResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of skus available for the virtual machine scale set. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_123 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The uri to fetch the next page of Virtual Machine Scale Set Skus. + Call ListNext() with this to fetch the next page of VMSS Skus. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: VirtualMachineScaleSetListSkusResult + - &ref_124 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the properties of a virtual machine scale set virtual machine. + name: + fixed: false + raw: VirtualMachineScaleSetVMProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies whether the latest model has been applied to the virtual + machine. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: latestModelApplied + realPath: + - latestModelApplied + serializedName: latestModelApplied + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Azure VM unique ID. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmId + realPath: + - vmId + serializedName: vmId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine instance view. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_60 + name: + fixed: false + raw: instanceView + realPath: + - instanceView + serializedName: instanceView + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the hardware settings for the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_55 + name: + fixed: false + raw: hardwareProfile + realPath: + - hardwareProfile + serializedName: hardwareProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the storage settings for the virtual machine disks. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_56 + name: + fixed: false + raw: storageProfile + realPath: + - storageProfile + serializedName: storageProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the operating system settings for the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_57 + name: + fixed: false + raw: osProfile + realPath: + - osProfile + serializedName: osProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the network interfaces of the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_58 + name: + fixed: false + raw: networkProfile + realPath: + - networkProfile + serializedName: networkProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies the boot diagnostic settings state.

    Minimum + api-version: 2015-06-15. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_59 + name: + fixed: false + raw: diagnosticsProfile + realPath: + - diagnosticsProfile + serializedName: diagnosticsProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the availability set that the virtual + machine should be assigned to. Virtual machines specified in the + same availability set are allocated to different nodes to maximize + availability. For more information about availability sets, see + [Manage the availability of virtual + machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). +

    For more information on Azure planned maintainance, see + [Planned maintenance for virtual machines in + Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) +

    Currently, a VM can only be added to availability set at + creation time. An existing VM cannot be added to an availability + set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: availabilitySet + realPath: + - availabilitySet + serializedName: availabilitySet + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The provisioning state, which only appears in the response.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies that the image or disk that is being used was licensed + on-premises. This element is only used for images that contain the + Windows Server operating system.

    Possible values are: +

    Windows_Client

    Windows_Server

    If this + element is included in a request for an update, the value must match + the initial value. This value cannot be updated.

    For more + information, see [Azure Hybrid Use Benefit for Windows + Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) +

    Minimum api-version: 2015-06-15 + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: licenseType + realPath: + - licenseType + serializedName: licenseType + serializedName: VirtualMachineScaleSetVMProperties + - &ref_126 + $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + documentation: Describes a virtual machine scale set virtual machine. + name: + fixed: false + raw: VirtualMachineScaleSetVM + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine instance ID. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + realPath: + - instanceId + serializedName: instanceId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine SKU. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_4 + name: + fixed: false + raw: sku + realPath: + - sku + serializedName: sku + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_124 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies information about the marketplace image used to create the + virtual machine. This element is only used for marketplace images. + Before you can use a marketplace image from an API, you must enable + the image for programmatic use. In the Azure portal, find the + marketplace image that you want to use and then click **Want to + deploy programmatically, Get Started ->**. Enter any required + information and then click **Save**. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_61 + name: + fixed: false + raw: plan + realPath: + - plan + serializedName: plan + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The virtual machine child extension resources. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_63 + name: + fixed: false + name: + fixed: false + raw: resources + realPath: + - resources + serializedName: resources + serializedName: VirtualMachineScaleSetVM + - &ref_125 + $type: CompositeType + containsConstantProperties: false + documentation: The health status of the VM. + name: + fixed: false + raw: VirtualMachineHealthStatus + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The health status information for the VM. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + serializedName: VirtualMachineHealthStatus + - &ref_166 + $type: CompositeType + containsConstantProperties: false + documentation: The instance view of a virtual machine scale set VM. + name: + fixed: false + raw: VirtualMachineScaleSetVMInstanceView + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Update Domain count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: platformUpdateDomain + realPath: + - platformUpdateDomain + serializedName: platformUpdateDomain + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Fault Domain count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: platformFaultDomain + realPath: + - platformFaultDomain + serializedName: platformFaultDomain + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Remote desktop certificate thumbprint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: rdpThumbPrint + realPath: + - rdpThumbPrint + serializedName: rdpThumbPrint + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The VM Agent running on the virtual machine. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_51 + name: + fixed: false + raw: vmAgent + realPath: + - vmAgent + serializedName: vmAgent + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The disks information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_53 + name: + fixed: false + name: + fixed: false + raw: disks + realPath: + - disks + serializedName: disks + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The extensions information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_9 + name: + fixed: false + name: + fixed: false + raw: extensions + realPath: + - extensions + serializedName: extensions + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The health status for the VM. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_125 + name: + fixed: false + raw: vmHealth + realPath: + - vmHealth + serializedName: vmHealth + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Boot Diagnostics is a debugging feature which allows you to view + Console Output and Screenshot to diagnose VM status.

    For + Linux Virtual Machines, you can easily view the output of your + console log.

    For both Windows and Linux virtual machines, + Azure also enables you to see a screenshot of the VM from the + hypervisor. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_54 + name: + fixed: false + raw: bootDiagnostics + realPath: + - bootDiagnostics + serializedName: bootDiagnostics + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The resource status information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_2 + name: + fixed: false + name: + fixed: false + raw: statuses + realPath: + - statuses + serializedName: statuses + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The placement group in which the VM is running. If the VM is + deallocated it will not have a placementGroupId. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: placementGroupId + realPath: + - placementGroupId + serializedName: placementGroupId + serializedName: VirtualMachineScaleSetVMInstanceView + - &ref_167 + $type: CompositeType + containsConstantProperties: false + documentation: The List Virtual Machine Scale Set VMs operation response. + name: + fixed: false + raw: VirtualMachineScaleSetVMListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of virtual machine scale sets VMs. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_126 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The uri to fetch the next page of Virtual Machine Scale Set VMs. + Call ListNext() with this to fetch the next page of VMSS VMs + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: VirtualMachineScaleSetVMListResult + - &ref_131 + $type: CompositeType + containsConstantProperties: false + documentation: Information about the current running state of the overall upgrade. + name: + fixed: false + raw: RollingUpgradeRunningStatus + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Code indicating the current status of the upgrade. + extensions: + x-ms-enum: + modelAsString: false + name: RollingUpgradeStatusCode + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_127 + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start time of the upgrade. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The last action performed on the rolling upgrade. + extensions: + x-ms-enum: + modelAsString: false + name: RollingUpgradeActionType + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_128 + name: + fixed: false + raw: lastAction + realPath: + - lastAction + serializedName: lastAction + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Last action time of the upgrade. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastActionTime + realPath: + - lastActionTime + serializedName: lastActionTime + serializedName: RollingUpgradeRunningStatus + - &ref_132 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Information about the number of virtual machine instances in each upgrade + state. + name: + fixed: false + raw: RollingUpgradeProgressInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The number of instances that have been successfully upgraded. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: successfulInstanceCount + realPath: + - successfulInstanceCount + serializedName: successfulInstanceCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The number of instances that have failed to be upgraded + successfully. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: failedInstanceCount + realPath: + - failedInstanceCount + serializedName: failedInstanceCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The number of instances that are currently being upgraded. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: inProgressInstanceCount + realPath: + - inProgressInstanceCount + serializedName: inProgressInstanceCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The number of instances that have not yet begun to be upgraded. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: pendingInstanceCount + realPath: + - pendingInstanceCount + serializedName: pendingInstanceCount + serializedName: RollingUpgradeProgressInfo + - &ref_129 + $type: CompositeType + containsConstantProperties: false + documentation: Api error base. + name: + fixed: false + raw: ApiErrorBase + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The error code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The target of the particular error. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: target + realPath: + - target + serializedName: target + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The error message. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: ApiErrorBase + - &ref_130 + $type: CompositeType + containsConstantProperties: false + documentation: Inner error details. + name: + fixed: false + raw: InnerError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The exception type. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: exceptiontype + realPath: + - exceptiontype + serializedName: exceptiontype + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The internal error message or exception dump. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: errordetail + realPath: + - errordetail + serializedName: errordetail + serializedName: InnerError + - &ref_133 + $type: CompositeType + containsConstantProperties: false + documentation: Api error. + name: + fixed: false + raw: ApiError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Api error details + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_129 + name: + fixed: false + name: + fixed: false + raw: details + realPath: + - details + serializedName: details + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Api inner error + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_130 + name: + fixed: false + raw: innererror + realPath: + - innererror + serializedName: innererror + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The error code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The target of the particular error. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: target + realPath: + - target + serializedName: target + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The error message. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: ApiError + - &ref_134 + $type: CompositeType + containsConstantProperties: false + documentation: The status of the latest virtual machine scale set rolling upgrade. + name: + fixed: false + raw: RollingUpgradeStatusInfoProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The rolling upgrade policies applied for this upgrade. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_67 + name: + fixed: false + raw: policy + realPath: + - policy + serializedName: policy + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Information about the current running state of the overall upgrade. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_131 + name: + fixed: false + raw: runningStatus + realPath: + - runningStatus + serializedName: runningStatus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Information about the number of virtual machine instances in each + upgrade state. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_132 + name: + fixed: false + raw: progress + realPath: + - progress + serializedName: progress + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Error details for this upgrade, if there are any.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_133 + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + serializedName: RollingUpgradeStatusInfoProperties + - &ref_165 + $type: CompositeType + baseModelType: *ref_7 + containsConstantProperties: false + documentation: The status of the latest virtual machine scale set rolling upgrade. + name: + fixed: false + raw: RollingUpgradeStatusInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_134 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: RollingUpgradeStatusInfo + - $type: CompositeType + containsConstantProperties: false + documentation: 'Compute-specific operation properties, including output' + name: + fixed: false + raw: ComputeLongRunningOperationProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Operation output data (raw JSON) + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: output + realPath: + - output + serializedName: output + serializedName: ComputeLongRunningOperationProperties + - *ref_7 + - *ref_135 + - *ref_136 + - &ref_139 + $type: CompositeType + containsConstantProperties: false + documentation: Operation status response + name: + fixed: false + raw: OperationStatusResponse + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Operation ID + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Operation status + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start time of the operation + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: End time of the operation + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Api error + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_133 + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + serializedName: OperationStatusResponse +modelsName: Models +name: ComputeManagementClient +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Create or update an availability set. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: AvailabilitySets + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the availability set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: availabilitySetName + serializedName: availabilitySetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters supplied to the Create Availability Set operation. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_5 + name: + fixed: false + raw: parameters + serializedName: parameters + - clientProperty: &ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: &ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_5 + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: AvailabilitySets_CreateOrUpdate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName} + - defaultResponse: + isNullable: true + deprecated: false + description: Delete an availability set. + group: + fixed: false + raw: AvailabilitySets + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the availability set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: availabilitySetName + serializedName: availabilitySetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: AvailabilitySets_Delete + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName} + - defaultResponse: + isNullable: true + deprecated: false + description: Retrieves information about an availability set. + group: + fixed: false + raw: AvailabilitySets + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the availability set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: availabilitySetName + serializedName: availabilitySetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_5 + isNullable: true + returnType: + body: *ref_5 + isNullable: true + serializedName: AvailabilitySets_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName} + - defaultResponse: + isNullable: true + deprecated: false + description: Lists all availability sets in a resource group. + extensions: + x-ms-pageable: + nextLinkName: null + group: + fixed: false + raw: AvailabilitySets + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_140 + isNullable: true + returnType: + body: *ref_140 + isNullable: true + serializedName: AvailabilitySets_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Lists all available virtual machine sizes that can be used to create a + new virtual machine in an existing availability set. + extensions: + x-ms-pageable: + nextLinkName: null + group: + fixed: false + raw: AvailabilitySets + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListAvailableSizes + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the availability set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: availabilitySetName + serializedName: availabilitySetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_141 + isNullable: true + returnType: + body: *ref_141 + isNullable: true + serializedName: AvailabilitySets_ListAvailableSizes + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes + name: + fixed: false + raw: AvailabilitySets + nameForProperty: AvailabilitySets + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a virtual machine extension image. + group: + fixed: false + raw: VirtualMachineExtensionImages + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of a supported Azure region. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisherName + serializedName: publisherName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: version + serializedName: version + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_142 + isNullable: true + returnType: + body: *ref_142 + isNullable: true + serializedName: VirtualMachineExtensionImages_Get + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a list of virtual machine extension image types. + group: + fixed: false + raw: VirtualMachineExtensionImages + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListTypes + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of a supported Azure region. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisherName + serializedName: publisherName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_143 + $type: SequenceType + elementType: *ref_142 + name: + fixed: false + isNullable: true + returnType: + body: *ref_143 + isNullable: true + serializedName: VirtualMachineExtensionImages_ListTypes + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a list of virtual machine extension image versions. + extensions: + x-ms-odata: '#/components/schemas/VirtualMachineExtensionImage' + group: + fixed: false + raw: VirtualMachineExtensionImages + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListVersions + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of a supported Azure region. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisherName + serializedName: publisherName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The filter to apply on the operation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $top + serializedName: $top + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $orderby + serializedName: $orderby + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_144 + $type: SequenceType + elementType: *ref_142 + name: + fixed: false + isNullable: true + returnType: + body: *ref_144 + isNullable: true + serializedName: VirtualMachineExtensionImages_ListVersions + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions + name: + fixed: false + raw: VirtualMachineExtensionImages + nameForProperty: VirtualMachineExtensionImages + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to create or update the extension. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '3' + group: + fixed: false + raw: VirtualMachineExtensions + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the virtual machine where the extension should be + create or updated. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine extension. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmExtensionName + serializedName: vmExtensionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Parameters supplied to the Create Virtual Machine Extension + operation. + extensions: + x-ms-requestBody-name: extensionParameters + isConstant: false + isRequired: true + location: body + modelType: *ref_63 + name: + fixed: false + raw: extensionParameters + serializedName: extensionParameters + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_63 + isNullable: true + OK: + body: *ref_63 + isNullable: true + returnType: + body: *ref_63 + isNullable: true + serializedName: VirtualMachineExtensions_CreateOrUpdate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName} + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to delete the extension. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineExtensions + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the virtual machine where the extension should be + deleted. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine extension. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmExtensionName + serializedName: vmExtensionName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineExtensions_Delete + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName} + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to get the extension. + group: + fixed: false + raw: VirtualMachineExtensions + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine containing the extension. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine extension. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmExtensionName + serializedName: vmExtensionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The expand expression to apply on the operation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_63 + isNullable: true + returnType: + body: *ref_63 + isNullable: true + serializedName: VirtualMachineExtensions_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName} + name: + fixed: false + raw: VirtualMachineExtensions + nameForProperty: VirtualMachineExtensions + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a virtual machine image. + group: + fixed: false + raw: VirtualMachineImages + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of a supported Azure region. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image publisher. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisherName + serializedName: publisherName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image publisher offer. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: offer + serializedName: offer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image SKU. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: skus + serializedName: skus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image SKU version. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: version + serializedName: version + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_145 + isNullable: true + returnType: + body: *ref_145 + isNullable: true + serializedName: VirtualMachineImages_Get + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a list of all virtual machine image versions for the specified + location, publisher, offer, and SKU. + extensions: + x-ms-odata: '#/components/schemas/VirtualMachineImageResource' + group: + fixed: false + raw: VirtualMachineImages + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of a supported Azure region. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image publisher. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisherName + serializedName: publisherName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image publisher offer. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: offer + serializedName: offer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image SKU. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: skus + serializedName: skus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The filter to apply on the operation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $top + serializedName: $top + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $orderby + serializedName: $orderby + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_146 + $type: SequenceType + elementType: *ref_15 + name: + fixed: false + isNullable: true + returnType: + body: *ref_146 + isNullable: true + serializedName: VirtualMachineImages_List + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a list of virtual machine image offers for the specified location + and publisher. + group: + fixed: false + raw: VirtualMachineImages + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListOffers + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of a supported Azure region. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image publisher. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisherName + serializedName: publisherName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_147 + $type: SequenceType + elementType: *ref_15 + name: + fixed: false + isNullable: true + returnType: + body: *ref_147 + isNullable: true + serializedName: VirtualMachineImages_ListOffers + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a list of virtual machine image publishers for the specified + Azure location. + group: + fixed: false + raw: VirtualMachineImages + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListPublishers + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of a supported Azure region. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_148 + $type: SequenceType + elementType: *ref_15 + name: + fixed: false + isNullable: true + returnType: + body: *ref_148 + isNullable: true + serializedName: VirtualMachineImages_ListPublishers + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a list of virtual machine image SKUs for the specified location, + publisher, and offer. + group: + fixed: false + raw: VirtualMachineImages + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListSkus + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of a supported Azure region. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image publisher. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publisherName + serializedName: publisherName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A valid image publisher offer. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: offer + serializedName: offer + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_149 + $type: SequenceType + elementType: *ref_15 + name: + fixed: false + isNullable: true + returnType: + body: *ref_149 + isNullable: true + serializedName: VirtualMachineImages_ListSkus + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus + name: + fixed: false + raw: VirtualMachineImages + nameForProperty: VirtualMachineImages + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets, for the specified location, the current compute resource usage + information as well as the limits for compute resources under the + subscription. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: Usage + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + constraints: + Pattern: '^[-\w\._]+$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: The location for which resource usage is queried. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_150 + isNullable: true + returnType: + body: *ref_150 + isNullable: true + serializedName: Usage_List + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages + name: + fixed: false + raw: Usage + nameForProperty: Usage + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Lists all available virtual machine sizes for a subscription in a + location. + extensions: + x-ms-pageable: + nextLinkName: null + group: + fixed: false + raw: VirtualMachineSizes + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + constraints: + Pattern: '^[-\w\._]+$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: The location upon which virtual-machine-sizes is queried. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + serializedName: location + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_141 + isNullable: true + returnType: + body: *ref_141 + isNullable: true + serializedName: VirtualMachineSizes_List + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes + name: + fixed: false + raw: VirtualMachineSizes + nameForProperty: VirtualMachineSizes + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Create or update an image. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: Images + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the image. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: imageName + serializedName: imageName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters supplied to the Create Image operation. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_73 + name: + fixed: false + raw: parameters + serializedName: parameters + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_73 + isNullable: true + OK: + body: *ref_73 + isNullable: true + returnType: + body: *ref_73 + isNullable: true + serializedName: Images_CreateOrUpdate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes an Image. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: Images + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the image. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: imageName + serializedName: imageName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: Images_Delete + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets an image. + group: + fixed: false + raw: Images + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the image. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: imageName + serializedName: imageName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The expand expression to apply on the operation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_73 + isNullable: true + returnType: + body: *ref_73 + isNullable: true + serializedName: Images_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the list of images under a resource group. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: Images + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListByResourceGroup + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_151 + isNullable: true + returnType: + body: *ref_151 + isNullable: true + serializedName: Images_ListByResourceGroup + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the list of Images in the subscription. Use nextLink property in + the response to get the next page of Images. Do this till nextLink is + not null to fetch all the Images. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: Images + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_151 + isNullable: true + returnType: + body: *ref_151 + isNullable: true + serializedName: Images_List + url: '/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images' + name: + fixed: false + raw: Images + nameForProperty: Images + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the list of Microsoft.Compute SKUs available for your + Subscription. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: ResourceSkus + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_152 + isNullable: true + returnType: + body: *ref_152 + isNullable: true + serializedName: ResourceSkus_List + url: '/subscriptions/{subscriptionId}/providers/Microsoft.Compute/skus' + name: + fixed: false + raw: ResourceSkus + nameForProperty: ResourceSkus + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Captures the VM by copying virtual hard disks of the VM and outputs a + template that can be used to create similar VMs. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Capture + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters supplied to the Capture Virtual Machine operation. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_153 + name: + fixed: false + raw: parameters + serializedName: parameters + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_154 + isNullable: true + returnType: + body: *ref_154 + isNullable: true + serializedName: VirtualMachines_Capture + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to create or update a virtual machine. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters supplied to the Create Virtual Machine operation. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_65 + name: + fixed: false + raw: parameters + serializedName: parameters + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_65 + isNullable: true + OK: + body: *ref_65 + isNullable: true + returnType: + body: *ref_65 + isNullable: true + serializedName: VirtualMachines_CreateOrUpdate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName} + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to delete a virtual machine. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachines_Delete + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Retrieves information about the model view or the instance view of a + virtual machine. + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The expand expression to apply on the operation. + extensions: + x-ms-enum: + modelAsString: false + name: InstanceViewTypes + isConstant: false + isRequired: false + location: query + modelType: *ref_155 + name: + fixed: false + raw: $expand + serializedName: $expand + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_65 + isNullable: true + returnType: + body: *ref_65 + isNullable: true + serializedName: VirtualMachines_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName} + - defaultResponse: + isNullable: true + deprecated: false + description: Retrieves information about the run-time state of a virtual machine. + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: InstanceView + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_60 + isNullable: true + returnType: + body: *ref_60 + isNullable: true + serializedName: VirtualMachines_InstanceView + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Converts virtual machine disks from blob-based to managed disks. + Virtual machine must be stop-deallocated before invoking this + operation. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ConvertToManagedDisks + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachines_ConvertToManagedDisks + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Shuts down the virtual machine and releases the compute resources. You + are not billed for the compute resources that this virtual machine + uses. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Deallocate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachines_Deallocate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate + - defaultResponse: + isNullable: true + deprecated: false + description: Sets the state of the virtual machine to generalized. + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Generalize + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachines_Generalize + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Lists all of the virtual machines in the specified resource group. Use + the nextLink property in the response to get the next page of virtual + machines. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_156 + isNullable: true + returnType: + body: *ref_156 + isNullable: true + serializedName: VirtualMachines_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Lists all of the virtual machines in the specified subscription. Use + the nextLink property in the response to get the next page of virtual + machines. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListAll + parameters: + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_156 + isNullable: true + returnType: + body: *ref_156 + isNullable: true + serializedName: VirtualMachines_ListAll + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Lists all available virtual machine sizes to which the specified + virtual machine can be resized. + extensions: + x-ms-pageable: + nextLinkName: null + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListAvailableSizes + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_141 + isNullable: true + returnType: + body: *ref_141 + isNullable: true + serializedName: VirtualMachines_ListAvailableSizes + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes + - defaultResponse: + isNullable: true + deprecated: false + description: >- + The operation to power off (stop) a virtual machine. The virtual + machine can be restarted with the same provisioned resources. You are + still charged for this virtual machine. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: PowerOff + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachines_PowerOff + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to restart a virtual machine. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Restart + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachines_Restart + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to start a virtual machine. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Start + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachines_Start + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to redeploy a virtual machine. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Redeploy + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachines_Redeploy + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to perform maintenance on a virtual machine. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachines + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: PerformMaintenance + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmName + serializedName: vmName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachines_PerformMaintenance + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance + name: + fixed: false + raw: VirtualMachines + nameForProperty: VirtualMachines + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Create or update a VM scale set. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set to create or update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The scale set object. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_120 + name: + fixed: false + raw: parameters + serializedName: parameters + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_120 + isNullable: true + OK: + body: *ref_120 + isNullable: true + returnType: + body: *ref_120 + isNullable: true + serializedName: VirtualMachineScaleSets_CreateOrUpdate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName} + - defaultResponse: + isNullable: true + deprecated: false + description: Update a VM scale set. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: Update + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set to create or update. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The scale set object. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_157 + name: + fixed: false + raw: parameters + serializedName: parameters + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_120 + isNullable: true + returnType: + body: *ref_120 + isNullable: true + serializedName: VirtualMachineScaleSets_Update + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a VM scale set. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSets_Delete + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName} + - defaultResponse: + isNullable: true + deprecated: false + description: Display information about a virtual machine scale set. + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_120 + isNullable: true + returnType: + body: *ref_120 + isNullable: true + serializedName: VirtualMachineScaleSets_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Deallocates specific virtual machines in a VM scale set. Shuts down + the virtual machines and releases the compute resources. You are not + billed for the compute resources that this virtual machine scale set + deallocates. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Deallocate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A list of virtual machine instance IDs from the VM scale set. + extensions: + x-ms-requestBody-name: vmInstanceIDs + isConstant: false + isRequired: false + location: body + modelType: *ref_158 + name: + fixed: false + raw: vmInstanceIDs + serializedName: vmInstanceIDs + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSets_Deallocate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes virtual machines in a VM scale set. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteInstances + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A list of virtual machine instance IDs from the VM scale set. + extensions: + x-ms-requestBody-name: vmInstanceIDs + isConstant: false + isRequired: true + location: body + modelType: *ref_159 + name: + fixed: false + raw: vmInstanceIDs + serializedName: vmInstanceIDs + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSets_DeleteInstances + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the status of a VM scale set instance. + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceView + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_160 + isNullable: true + returnType: + body: *ref_160 + isNullable: true + serializedName: VirtualMachineScaleSets_GetInstanceView + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a list of all VM scale sets under a resource group. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_161 + isNullable: true + returnType: + body: *ref_161 + isNullable: true + serializedName: VirtualMachineScaleSets_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a list of all VM Scale Sets in the subscription, regardless of + the associated resource group. Use nextLink property in the response + to get the next page of VM Scale Sets. Do this till nextLink is not + null to fetch all the VM Scale Sets. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListAll + parameters: + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_162 + isNullable: true + returnType: + body: *ref_162 + isNullable: true + serializedName: VirtualMachineScaleSets_ListAll + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a list of SKUs available for your VM scale set, including the + minimum and maximum VM instances allowed for each SKU. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListSkus + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_163 + isNullable: true + returnType: + body: *ref_163 + isNullable: true + serializedName: VirtualMachineScaleSets_ListSkus + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Power off (stop) one or more virtual machines in a VM scale set. Note + that resources are still attached and you are getting charged for the + resources. Instead, use deallocate to release resources and avoid + charges. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: PowerOff + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A list of virtual machine instance IDs from the VM scale set. + extensions: + x-ms-requestBody-name: vmInstanceIDs + isConstant: false + isRequired: false + location: body + modelType: *ref_158 + name: + fixed: false + raw: vmInstanceIDs + serializedName: vmInstanceIDs + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSets_PowerOff + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff + - defaultResponse: + isNullable: true + deprecated: false + description: Restarts one or more virtual machines in a VM scale set. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Restart + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A list of virtual machine instance IDs from the VM scale set. + extensions: + x-ms-requestBody-name: vmInstanceIDs + isConstant: false + isRequired: false + location: body + modelType: *ref_158 + name: + fixed: false + raw: vmInstanceIDs + serializedName: vmInstanceIDs + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSets_Restart + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart + - defaultResponse: + isNullable: true + deprecated: false + description: Starts one or more virtual machines in a VM scale set. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Start + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A list of virtual machine instance IDs from the VM scale set. + extensions: + x-ms-requestBody-name: vmInstanceIDs + isConstant: false + isRequired: false + location: body + modelType: *ref_158 + name: + fixed: false + raw: vmInstanceIDs + serializedName: vmInstanceIDs + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSets_Start + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Upgrades one or more virtual machines to the latest SKU set in the VM + scale set model. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateInstances + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A list of virtual machine instance IDs from the VM scale set. + extensions: + x-ms-requestBody-name: vmInstanceIDs + isConstant: false + isRequired: true + location: body + modelType: *ref_159 + name: + fixed: false + raw: vmInstanceIDs + serializedName: vmInstanceIDs + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSets_UpdateInstances + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Reimages (upgrade the operating system) one or more virtual machines + in a VM scale set. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Reimage + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A list of virtual machine instance IDs from the VM scale set. + extensions: + x-ms-requestBody-name: vmInstanceIDs + isConstant: false + isRequired: false + location: body + modelType: *ref_158 + name: + fixed: false + raw: vmInstanceIDs + serializedName: vmInstanceIDs + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSets_Reimage + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Reimages all the disks ( including data disks ) in the virtual + machines in a VM scale set. This operation is only supported for + managed disks. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: VirtualMachineScaleSets + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ReimageAll + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A list of virtual machine instance IDs from the VM scale set. + extensions: + x-ms-requestBody-name: vmInstanceIDs + isConstant: false + isRequired: false + location: body + modelType: *ref_158 + name: + fixed: false + raw: vmInstanceIDs + serializedName: vmInstanceIDs + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSets_ReimageAll + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall + name: + fixed: false + raw: VirtualMachineScaleSets + nameForProperty: VirtualMachineScaleSets + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to create or update an extension. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '3' + group: + fixed: false + raw: VirtualMachineScaleSetExtensions + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the VM scale set where the extension should be + create or updated. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set extension. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmssExtensionName + serializedName: vmssExtensionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Parameters supplied to the Create VM scale set Extension + operation. + extensions: + x-ms-requestBody-name: extensionParameters + isConstant: false + isRequired: true + location: body + modelType: *ref_103 + name: + fixed: false + raw: extensionParameters + serializedName: extensionParameters + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_103 + isNullable: true + OK: + body: *ref_103 + isNullable: true + returnType: + body: *ref_103 + isNullable: true + serializedName: VirtualMachineScaleSetExtensions_CreateOrUpdate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName} + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to delete the extension. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetExtensions + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the VM scale set where the extension should be + deleted. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set extension. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmssExtensionName + serializedName: vmssExtensionName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetExtensions_Delete + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName} + - defaultResponse: + isNullable: true + deprecated: false + description: The operation to get the extension. + group: + fixed: false + raw: VirtualMachineScaleSetExtensions + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set containing the extension. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set extension. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmssExtensionName + serializedName: vmssExtensionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The expand expression to apply on the operation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_103 + isNullable: true + returnType: + body: *ref_103 + isNullable: true + serializedName: VirtualMachineScaleSetExtensions_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a list of all extensions in a VM scale set. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: VirtualMachineScaleSetExtensions + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set containing the extension. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_164 + isNullable: true + returnType: + body: *ref_164 + isNullable: true + serializedName: VirtualMachineScaleSetExtensions_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions + name: + fixed: false + raw: VirtualMachineScaleSetExtensions + nameForProperty: VirtualMachineScaleSetExtensions + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Cancels the current virtual machine scale set rolling upgrade. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetRollingUpgrades + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Cancel + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetRollingUpgrades_Cancel + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Starts a rolling upgrade to move all virtual machine scale set + instances to the latest available Platform Image OS version. Instances + which are already running the latest available OS version are not + affected. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetRollingUpgrades + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StartOSUpgrade + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the status of the latest virtual machine scale set rolling + upgrade. + group: + fixed: false + raw: VirtualMachineScaleSetRollingUpgrades + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetLatest + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_165 + isNullable: true + returnType: + body: *ref_165 + isNullable: true + serializedName: VirtualMachineScaleSetRollingUpgrades_GetLatest + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest + name: + fixed: false + raw: VirtualMachineScaleSetRollingUpgrades + nameForProperty: VirtualMachineScaleSetRollingUpgrades + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Reimages (upgrade the operating system) a specific virtual machine in + a VM scale set. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Reimage + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance ID of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_Reimage + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Allows you to re-image all the disks ( including data disks ) in the a + VM scale set instance. This operation is only supported for managed + disks. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ReimageAll + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance ID of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_ReimageAll + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Deallocates a specific virtual machine in a VM scale set. Shuts down + the virtual machine and releases the compute resources it uses. You + are not billed for the compute resources of this virtual machine once + it is deallocated. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Deallocate + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance ID of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_Deallocate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a virtual machine from a VM scale set. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance ID of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NoContent: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_Delete + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a virtual machine from a VM scale set. + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance ID of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_126 + isNullable: true + returnType: + body: *ref_126 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the status of a virtual machine from a VM scale set. + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceView + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance ID of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_166 + isNullable: true + returnType: + body: *ref_166 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_GetInstanceView + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/instanceView + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a list of all virtual machines in a VM scale sets. + extensions: + x-ms-odata: '#/components/schemas/VirtualMachineScaleSetVM' + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: virtualMachineScaleSetName + serializedName: virtualMachineScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The filter to apply to the operation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list parameters. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The expand expression to apply to the operation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $expand + serializedName: $expand + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_167 + isNullable: true + returnType: + body: *ref_167 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Power off (stop) a virtual machine in a VM scale set. Note that + resources are still attached and you are getting charged for the + resources. Instead, use deallocate to release resources and avoid + charges. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: PowerOff + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance ID of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_PowerOff + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff + - defaultResponse: + isNullable: true + deprecated: false + description: Restarts a virtual machine in a VM scale set. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Restart + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance ID of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_Restart + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart + - defaultResponse: + isNullable: true + deprecated: false + description: Starts a virtual machine in a VM scale set. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: VirtualMachineScaleSetVMs + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Start + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the VM scale set. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vmScaleSetName + serializedName: vmScaleSetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The instance ID of the virtual machine. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_137 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_138 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for + every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_139 + isNullable: true + returnType: + body: *ref_139 + isNullable: true + serializedName: VirtualMachineScaleSetVMs_Start + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start + name: + fixed: false + raw: VirtualMachineScaleSetVMs + nameForProperty: VirtualMachineScaleSetVMs + typeName: + fixed: false +properties: + - *ref_138 + - *ref_137 diff --git a/test/Expected/specs-datalake-store/code-model-v1-yaml.yaml b/test/Expected/specs-datalake-store/code-model-v1-yaml.yaml new file mode 100644 index 0000000..1936177 --- /dev/null +++ b/test/Expected/specs-datalake-store/code-model-v1-yaml.yaml @@ -0,0 +1,4249 @@ +--- +apiVersion: '2016-11-01' +baseUrl: 'https://{accountName}.{adlsFileSystemDnsSuffix}' +codeGenExtensions: + internalConstructors: true +documentation: Creates an Azure Data Lake Store filesystem client. +enumTypes: + - &ref_2 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: FileType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: FILE + serializedName: FILE + - name: DIRECTORY + serializedName: DIRECTORY + - &ref_7 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ExpiryOptionType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: NeverExpire + serializedName: NeverExpire + - name: RelativeToNow + serializedName: RelativeToNow + - name: RelativeToCreationDate + serializedName: RelativeToCreationDate + - name: Absolute + serializedName: Absolute + - &ref_8 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: AppendModeType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: autocreate + serializedName: autocreate + - &ref_9 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: SyncFlag + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: DATA + serializedName: DATA + - name: METADATA + serializedName: METADATA + - name: CLOSE + serializedName: CLOSE +errorTypes: + - &ref_6 + $type: CompositeType + containsConstantProperties: false + documentation: Data Lake Store filesystem error containing a specific WebHDFS exception. + name: + fixed: false + raw: AdlsError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the object representing the actual WebHDFS exception being returned. + isConstant: false + isReadOnly: true + isRequired: false + modelType: &ref_5 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Data Lake Store filesystem exception based on the WebHDFS definition + for RemoteExceptions. This is a WebHDFS 'catch all' exception + name: + fixed: false + raw: AdlsRemoteException + polymorphicDiscriminator: exception + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + the full class package name for the exception thrown, such as + 'java.lang.IllegalArgumentException'. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: javaClassName + realPath: + - javaClassName + serializedName: javaClassName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + the message associated with the exception that was thrown, + such as 'Invalid value for webhdfs parameter + "permission":...'. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: AdlsRemoteException + name: + fixed: false + raw: RemoteException + realPath: + - RemoteException + serializedName: RemoteException + serializedName: AdlsError +extensions: + x-ms-parameterized-host: + hostTemplate: 'https://{accountName}.{adlsFileSystemDnsSuffix}' + parameters: + - description: The Azure Data Lake Store account to execute filesystem operations on. + in: path + name: accountName + required: true + schema: + description: >- + The Azure Data Lake Store account to execute filesystem operations + on. + in: path + name: accountName + type: string + x-ms-skip-url-encoding: true + type: string + x-ms-skip-url-encoding: true + - $ref: '#/components/parameters/adlsFilesystemDnsSuffixInPath' +hostParametersFront: + - clientProperty: &ref_17 + collectionFormat: none + defaultValue: + fixed: false + raw: azuredatalakestore.net + documentation: + fixed: false + raw: Gets the URI used as the base for all cloud service requests. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: adlsFileSystemDnsSuffix + realPath: + - adlsFileSystemDnsSuffix + serializedName: adlsFileSystemDnsSuffix + collectionFormat: none + defaultValue: + fixed: false + raw: azuredatalakestore.net + documentation: + fixed: false + raw: Gets the URI used as the base for all cloud service requests. + extensions: + hostParameter: true + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: adlsFileSystemDnsSuffix + serializedName: adlsFileSystemDnsSuffix + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Azure Data Lake Store account to execute filesystem operations on. + extensions: + hostParameter: true + type: string + x-ms-skip-url-encoding: true + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: accountName + serializedName: accountName +modelTypes: + - &ref_11 + $type: CompositeType + containsConstantProperties: false + documentation: The result of the request or operation. + name: + fixed: false + raw: FileOperationResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the result of the operation or request. + extensions: + x-ms-client-name: operationResult + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolean + realPath: + - boolean + serializedName: boolean + serializedName: FileOperationResult + - &ref_0 + $type: CompositeType + containsConstantProperties: false + documentation: Data Lake Store file or directory Access Control List information. + name: + fixed: false + raw: AclStatus + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the list of ACLSpec entries on a file or directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: entries + realPath: + - entries + serializedName: entries + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'the group owner, an AAD Object ID.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: group + realPath: + - group + serializedName: group + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'the user owner, an AAD Object ID.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: owner + realPath: + - owner + serializedName: owner + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The octal representation of the unnamed user, mask and other + permissions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: permission + realPath: + - permission + serializedName: permission + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the indicator of whether the sticky bit is on or off. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: stickyBit + realPath: + - stickyBit + serializedName: stickyBit + serializedName: AclStatus + - &ref_16 + $type: CompositeType + containsConstantProperties: false + documentation: Data Lake Store file or directory Access Control List information. + name: + fixed: false + raw: AclStatusResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the AclStatus object for a given file or directory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: AclStatus + realPath: + - AclStatus + serializedName: AclStatus + serializedName: AclStatusResult + - &ref_1 + $type: CompositeType + containsConstantProperties: false + documentation: Data Lake Store content summary information + name: + fixed: false + raw: ContentSummary + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the number of directories. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: directoryCount + realPath: + - directoryCount + serializedName: directoryCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the number of files. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: fileCount + realPath: + - fileCount + serializedName: fileCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the number of bytes used by the content. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: length + realPath: + - length + serializedName: length + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the disk space consumed by the content. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: spaceConsumed + realPath: + - spaceConsumed + serializedName: spaceConsumed + serializedName: ContentSummary + - &ref_13 + $type: CompositeType + containsConstantProperties: false + documentation: Data Lake Store filesystem content summary information response. + name: + fixed: false + raw: ContentSummaryResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the content summary for the specified path + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: ContentSummary + realPath: + - ContentSummary + serializedName: ContentSummary + serializedName: ContentSummaryResult + - &ref_3 + $type: CompositeType + containsConstantProperties: false + documentation: Data Lake Store file or directory information. + name: + fixed: false + raw: FileStatusProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the last access time as ticks since the epoch. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: accessTime + realPath: + - accessTime + serializedName: accessTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the block size for the file. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: blockSize + realPath: + - blockSize + serializedName: blockSize + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the number of children in the directory. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: childrenNum + realPath: + - childrenNum + serializedName: childrenNum + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets the expiration time, if any, as ticks since the epoch. If the + value is 0 or DateTime.MaxValue there is no expiration. + extensions: + x-ms-client-name: expirationTime + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: msExpirationTime + realPath: + - msExpirationTime + serializedName: msExpirationTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the group owner. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: group + realPath: + - group + serializedName: group + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the number of bytes in a file. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: length + realPath: + - length + serializedName: length + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the modification time as ticks since the epoch. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: modificationTime + realPath: + - modificationTime + serializedName: modificationTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the user who is the owner. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: owner + realPath: + - owner + serializedName: owner + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the path suffix. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathSuffix + realPath: + - pathSuffix + serializedName: pathSuffix + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the permission represented as an string. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: permission + realPath: + - permission + serializedName: permission + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the type of the path object. + extensions: + x-ms-enum: + modelAsString: false + name: FileType + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'flag to indicate if extended acls are enabled ' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: aclBit + realPath: + - aclBit + serializedName: aclBit + serializedName: FileStatusProperties + - &ref_4 + $type: CompositeType + containsConstantProperties: false + documentation: Data Lake Store file status list information. + name: + fixed: false + raw: FileStatuses + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the object containing the list of properties of the files. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_3 + name: + fixed: false + name: + fixed: false + raw: FileStatus + realPath: + - FileStatus + serializedName: FileStatus + serializedName: FileStatuses + - &ref_12 + $type: CompositeType + containsConstantProperties: false + documentation: Data Lake Store filesystem file status list information response. + name: + fixed: false + raw: FileStatusesResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the object representing the list of file statuses. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_4 + name: + fixed: false + raw: FileStatuses + realPath: + - FileStatuses + serializedName: FileStatuses + serializedName: FileStatusesResult + - &ref_14 + $type: CompositeType + containsConstantProperties: false + documentation: Data Lake Store filesystem file status information response. + name: + fixed: false + raw: FileStatusResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: the file status object associated with the specified path. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: FileStatus + realPath: + - FileStatus + serializedName: FileStatus + serializedName: FileStatusResult + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown indicating that one more arguments is + incorrect. Thrown when a 400 error response code is returned (bad + request). + extensions: + x-ms-discriminator-value: IllegalArgumentException + name: + fixed: false + raw: AdlsIllegalArgumentException + serializedName: IllegalArgumentException + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown indicating that the requested operation is not + supported. Thrown when a 400 error response code is returned (bad + request). + extensions: + x-ms-discriminator-value: UnsupportedOperationException + name: + fixed: false + raw: AdlsUnsupportedOperationException + serializedName: UnsupportedOperationException + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown indicating that access is denied. Thrown when a + 401 error response code is returned (Unauthorized). + extensions: + x-ms-discriminator-value: SecurityException + name: + fixed: false + raw: AdlsSecurityException + serializedName: SecurityException + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown indicating there was an IO (read or write) + error. Thrown when a 403 error response code is returned (forbidden). + extensions: + x-ms-discriminator-value: IOException + name: + fixed: false + raw: AdlsIOException + serializedName: IOException + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown indicating the file or folder could not be + found. Thrown when a 404 error response code is returned (not found). + extensions: + x-ms-discriminator-value: FileNotFoundException + name: + fixed: false + raw: AdlsFileNotFoundException + serializedName: FileNotFoundException + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown indicating the file or folder already exists. + Thrown when a 403 error response code is returned (forbidden). + extensions: + x-ms-discriminator-value: FileAlreadyExistsException + name: + fixed: false + raw: AdlsFileAlreadyExistsException + serializedName: FileAlreadyExistsException + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown indicating the append or read is from a bad + offset. Thrown when a 400 error response code is returned for append and + open operations (Bad request). + extensions: + x-ms-discriminator-value: BadOffsetException + name: + fixed: false + raw: AdlsBadOffsetException + serializedName: BadOffsetException + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown when an unexpected error occurs during an + operation. Thrown when a 500 error response code is returned (Internal + server error). + extensions: + x-ms-discriminator-value: RuntimeException + name: + fixed: false + raw: AdlsRuntimeException + serializedName: RuntimeException + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown indicating that access is denied due to + insufficient permissions. Thrown when a 403 error response code is + returned (forbidden). + extensions: + x-ms-discriminator-value: AccessControlException + name: + fixed: false + raw: AdlsAccessControlException + serializedName: AccessControlException + - $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: >- + A WebHDFS exception thrown indicating that the request is being throttled. + Reducing the number of requests or request size helps to mitigate this + error. + extensions: + x-ms-discriminator-value: ThrottledException + name: + fixed: false + raw: AdlsThrottledException + serializedName: ThrottledException + - *ref_5 + - *ref_6 +modelsName: Models +name: DataLakeStoreFileSystemManagementClient +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Sets or removes the expiration time on the specified file. This + operation can only be executed against files. Folders are not + supported. + extensions: + x-ms-examples: + Sets or removes the expiration time on the specified file. This operation can only be executed against files. Folders are not supported: + parameters: + api-version: '2016-11-01' + expireTime: '1' + expiryOption: NeverExpire + op: SETEXPIRY + path: /test_file_path + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: SetFileExpiry + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file on + which to set or remove the expiration time. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Indicates the type of expiration to use for the file: 1. + NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime + is an integer in milliseconds representing the expiration date + relative to when file expiration is updated. 3. + RelativeToCreationDate: ExpireTime is an integer in milliseconds + representing the expiration date relative to file creation. 4. + Absolute: ExpireTime is an integer in milliseconds, as a Unix + timestamp relative to 1/1/1970 00:00:00. + extensions: + x-ms-enum: + modelAsString: false + name: ExpiryOptionType + isConstant: false + isRequired: true + location: query + modelType: *ref_7 + name: + fixed: false + raw: expiryOption + serializedName: expiryOption + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time that the file will expire, corresponding to the + ExpiryOption that was set. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: expireTime + serializedName: expireTime + - collectionFormat: none + defaultValue: + fixed: false + raw: SETEXPIRY + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: &ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_SetFileExpiry + url: '/WebHdfsExt/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Appends to the specified file, optionally first creating the file if + it does not yet exist. This method supports multiple concurrent + appends to the file. NOTE: The target must not contain data added by + Create or normal (serial) Append. ConcurrentAppend and Append cannot + be used interchangeably; once a target file has been modified using + either of these append options, the other append option cannot be used + on the target file. ConcurrentAppend does not guarantee order and can + result in duplicated data landing in the target file. + extensions: + x-ms-examples: + 'Appends to the specified file, optionally first creating the file if it does not yet exist. This method supports multiple concurrent appends to the file. NOTE: The target must not contain data added by Create or normal (serial) Append. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file. ConcurrentAppend does not guarantee order and can result in duplicated data landing in the target file': + parameters: + Transfer-Encoding: chunked + api-version: '2016-11-01' + appendMode: autocreate + op: CONCURRENTAPPEND + path: /test_file_path + streamContents: >- + This is actually a byte stream. This request/response is being + presented as a string for readability in the example + syncFlag: DATA + responses: + '200': {} + x-ms-requestBody-index: '1' + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ConcurrentAppend + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file to + which to append using concurrent append. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file contents to include when appending to the file. + extensions: + x-ms-requestBody-name: streamContents + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + name: + fixed: false + raw: streamContents + serializedName: streamContents + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Indicates the concurrent append call should create the file if + it doesn't exist or just open the existing file for append + extensions: + x-ms-enum: + modelAsString: false + name: AppendModeType + isConstant: false + isRequired: false + location: query + modelType: *ref_8 + name: + fixed: false + raw: appendMode + serializedName: appendMode + - collectionFormat: none + defaultValue: + fixed: false + raw: CONCURRENTAPPEND + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - collectionFormat: none + defaultValue: + fixed: false + raw: chunked + documentation: + fixed: false + raw: >- + Indicates the data being sent to the server is being streamed in + chunks. + isConstant: true + isRequired: true + location: header + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Transfer-Encoding + serializedName: Transfer-Encoding + - collectionFormat: none + defaultValue: + fixed: false + raw: DATA + documentation: + fixed: false + raw: >- + Optionally indicates what to do after completion of the + concurrent append. DATA indicates that more data will be sent + immediately by the client, the file handle should remain + open/locked, and file metadata (including file length, last + modified time) should NOT get updated. METADATA indicates that + more data will be sent immediately by the client, the file + handle should remain open/locked, and file metadata should get + updated. CLOSE indicates that the client is done sending data, + the file handle should be closed/unlocked, and file metadata + should get updated. + extensions: + x-ms-enum: + modelAsString: false + name: SyncFlag + isConstant: false + isRequired: false + location: query + modelType: *ref_9 + name: + fixed: false + raw: syncFlag + serializedName: syncFlag + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/octet-stream + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_ConcurrentAppend + url: '/WebHdfsExt/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: Checks if the specified access is available at the given path. + extensions: + x-ms-examples: + Checks if the specified access is available at the given path: + parameters: + api-version: '2016-11-01' + fsaction: test_fsaction + op: CHECKACCESS + path: /test_file_path + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: CheckAccess + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory for which to check access. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + File system operation read/write/execute in string form, + matching regex pattern '[rwx-]{3}' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: fsaction + serializedName: fsaction + - collectionFormat: none + defaultValue: + fixed: false + raw: CHECKACCESS + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_CheckAccess + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: Creates a directory. + extensions: + x-ms-examples: + Creates a directory: + parameters: + api-version: '2016-11-01' + op: MKDIRS + path: /test_file_path + permission: '1' + responses: + '200': + body: + boolean: false + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: Mkdirs + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the directory to + create. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Optional octal permission with which the directory should be + created. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: permission + serializedName: permission + - collectionFormat: none + defaultValue: + fixed: false + raw: MKDIRS + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_11 + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: FileSystem_Mkdirs + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Concatenates the list of source files into the destination file, + removing all source files upon success. + extensions: + x-ms-examples: + 'Concatenates the list of source files into the destination file, removing all source files upon success': + parameters: + api-version: '2016-11-01' + op: CONCAT + path: /test_file_path + sources: + - test_source_1 + - test_source_2 + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Concat + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the destination + file resulting from the concatenation. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A list of comma separated Data Lake Store paths (starting with + '/') of the files to concatenate, in the order in which they + should be concatenated. + isConstant: false + isRequired: true + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: sources + serializedName: sources + - collectionFormat: none + defaultValue: + fixed: false + raw: CONCAT + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_Concat + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Concatenates the list of source files into the destination file, + deleting all source files upon success. This method accepts more + source file paths than the Concat method. This method and the + parameters it accepts are subject to change for usability in an + upcoming version. + extensions: + x-ms-examples: + 'Concatenates the list of source files into the destination file, deleting all source files upon success. This method accepts more source file paths than the Concat method. This method and the parameters it accepts are subject to change for usability in an upcoming version': + parameters: + api-version: '2016-11-01' + deleteSourceDirectory: false + op: MSCONCAT + path: /test_file_path + streamContents: >- + sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv + responses: + '200': {} + x-ms-requestBody-index: '2' + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: MsConcat + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the destination + file resulting from the concatenation. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Indicates that as an optimization instead of deleting each + individual source stream, delete the source stream folder if all + streams are in the same folder instead. This results in a + substantial performance improvement when the only streams in the + folder are part of the concatenation operation. WARNING: This + includes the deletion of any other files that are not source + files. Only set this to true when source files are the only + files in the source directory. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: deleteSourceDirectory + serializedName: deleteSourceDirectory + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A list of Data Lake Store paths (starting with '/') of the + source files. Must be a comma-separated path list in the format: + sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv + extensions: + x-ms-requestBody-name: streamContents + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + name: + fixed: false + raw: streamContents + serializedName: streamContents + - collectionFormat: none + defaultValue: + fixed: false + raw: MSCONCAT + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/octet-stream + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_MsConcat + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Get the list of file status objects specified by the file path, with + optional pagination parameters + extensions: + x-ms-examples: + 'Get the list of file status objects specified by the file path, with optional pagination parameters': + parameters: + api-version: '2016-11-01' + listAfter: test_list_after + listBefore: test_list_before + listSize: '1' + op: LISTSTATUS + path: /test_file_path + tooId: false + responses: + '200': + body: + FileStatuses: + FileStatus: + - accessTime: '1' + aclBit: false + blockSize: '1' + childrenNum: '1' + group: test_group + length: '1' + modificationTime: '1' + msExpirationTime: '1' + owner: test_owner + pathSuffix: test_path_suffix + permission: test_permission + type: FILE + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListFileStatus + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the directory to + list. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets or sets the number of items to return. Optional. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: listSize + serializedName: listSize + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets or sets the item or lexographical index after which to + begin returning results. For example, a file list of 'a','b','d' + and listAfter='b' will return 'd', and a listAfter='c' will also + return 'd'. Optional. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: listAfter + serializedName: listAfter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets or sets the item or lexographical index before which to + begin returning results. For example, a file list of 'a','b','d' + and listBefore='d' will return 'a','b', and a listBefore='c' + will also return 'a','b'. Optional. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: listBefore + serializedName: listBefore + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An optional switch to return friendly names in place of owner + and group. tooid=false returns friendly names instead of the AAD + Object ID. Default value is true, returning AAD object IDs. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: tooId + serializedName: tooId + - collectionFormat: none + defaultValue: + fixed: false + raw: LISTSTATUS + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_12 + isNullable: true + returnType: + body: *ref_12 + isNullable: true + serializedName: FileSystem_ListFileStatus + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: Gets the file content summary object specified by the file path. + extensions: + x-ms-examples: + Gets the file content summary object specified by the file path: + parameters: + api-version: '2016-11-01' + op: GETCONTENTSUMMARY + path: /test_file_path + responses: + '200': + body: + ContentSummary: + directoryCount: '1' + fileCount: '1' + length: '1' + spaceConsumed: '1' + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetContentSummary + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file for + which to retrieve the summary. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + raw: GETCONTENTSUMMARY + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_13 + isNullable: true + returnType: + body: *ref_13 + isNullable: true + serializedName: FileSystem_GetContentSummary + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: Get the file status object specified by the file path. + extensions: + x-ms-examples: + Get the file status object specified by the file path: + parameters: + api-version: '2016-11-01' + op: GETFILESTATUS + path: /test_file_path + tooId: false + responses: + '200': + body: + FileStatus: + accessTime: '1' + aclBit: false + blockSize: '1' + childrenNum: '1' + group: test_group + length: '1' + modificationTime: '1' + msExpirationTime: '1' + owner: test_owner + pathSuffix: test_path_suffix + permission: test_permission + type: FILE + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetFileStatus + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory for which to retrieve the status. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An optional switch to return friendly names in place of owner + and group. tooid=false returns friendly names instead of the AAD + Object ID. Default value is true, returning AAD object IDs. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: tooId + serializedName: tooId + - collectionFormat: none + defaultValue: + fixed: false + raw: GETFILESTATUS + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_14 + isNullable: true + returnType: + body: *ref_14 + isNullable: true + serializedName: FileSystem_GetFileStatus + url: '/webhdfs/v1/{path}' + - defaultResponse: + isNullable: true + deprecated: false + description: Opens and reads from the specified file. + extensions: + x-ms-examples: + Opens and reads from the specified file: + parameters: + api-version: '2016-11-01' + fileSessionId: 34adfa4f-cedf-4dc0-ba29-b6d1a69ab345 + length: '1' + offset: '1' + op: OPEN + path: /test_file_path + read: 'true' + responses: + '200': + body: >- + This is actually a byte stream. This request/response is + being presented as a string for readability in the example + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Open + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file to + open. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The number of bytes that the server will attempt to retrieve. It + will retrieve <= length bytes. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: length + serializedName: length + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The byte offset to start reading data from. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: offset + serializedName: offset + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Optional unique GUID per file indicating all the reads with the + same fileSessionId are from the same client and same session. + This will give a performance benefit. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: fileSessionId + serializedName: fileSessionId + - collectionFormat: none + defaultValue: + fixed: false + raw: 'true' + documentation: + fixed: false + raw: >- + Flag to skip redirection. When read=false or not specified, the + request is redirected. Submit another HTTP PUT request using the + URL in the Location header with the file data to be read. When + read=true, this redirection is skipped. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: read + serializedName: read + - collectionFormat: none + defaultValue: + fixed: false + raw: OPEN + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/octet-stream + responses: + OK: + body: &ref_15 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_15 + isNullable: true + serializedName: FileSystem_Open + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: "Used for serial appends to the specified file.\_NOTE: The target must not contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file." + extensions: + x-ms-examples: + "Used for serial appends to the specified file.\_NOTE: The target must not contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file": + parameters: + api-version: '2016-11-01' + append: 'true' + fileSessionId: 34adfa4f-cedf-4dc0-ba29-b6d1a69ab346 + leaseId: 34adfa4f-cedf-4dc0-ba29-b6d1a69ab345 + offset: '1' + op: APPEND + path: /test_file_path + streamContents: >- + This is actually a byte stream. This request/response is being + presented as a string for readability in the example + syncFlag: DATA + responses: + '200': {} + x-ms-requestBody-index: '1' + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Append + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file to + which to append. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The file contents to include when appending to the file. + extensions: + x-ms-requestBody-name: streamContents + isConstant: false + isRequired: true + location: body + modelType: + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + name: + fixed: false + raw: streamContents + serializedName: streamContents + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The optional offset in the stream to begin the append operation. + Default is to append at the end of the stream. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: offset + serializedName: offset + - collectionFormat: none + defaultValue: + fixed: false + raw: CLOSE + documentation: + fixed: false + raw: >- + Optionally indicates what to do after completion of the + concurrent append. DATA indicates that more data will be sent + immediately by the client, the file handle should remain + open/locked, and file metadata (including file length, last + modified time) should NOT get updated. METADATA indicates that + more data will be sent immediately by the client, the file + handle should remain open/locked, and file metadata should get + updated. CLOSE indicates that the client is done sending data, + the file handle should be closed/unlocked, and file metadata + should get updated. + extensions: + x-ms-enum: + modelAsString: false + name: SyncFlag + isConstant: false + isRequired: false + location: query + modelType: *ref_9 + name: + fixed: false + raw: syncFlag + serializedName: syncFlag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Optional unique GUID per file to ensure single writer semantics, + meaning that only clients that append to the file with the same + leaseId will be allowed to do so. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: leaseId + serializedName: leaseId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Optional unique GUID per file indicating all the appends with + the same fileSessionId are from the same client and same + session. This will give a performance benefit when syncFlag is + DATA or METADATA. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: fileSessionId + serializedName: fileSessionId + - collectionFormat: none + defaultValue: + fixed: false + raw: 'true' + documentation: + fixed: false + raw: >- + Flag to skip redirection. When append=false or not specified, + the request is redirected. Submit another HTTP PUT request using + the URL in the Location header with the file data to be written. + When append=true, this redirection is skipped. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: append + serializedName: append + - collectionFormat: none + defaultValue: + fixed: false + raw: APPEND + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/octet-stream + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_Append + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Creates a file with optionally specified content. NOTE: If content is + provided, the resulting file cannot be modified using + ConcurrentAppend. + extensions: + x-ms-examples: + 'Creates a file with optionally specified content. NOTE: If content is provided, the resulting file cannot be modified using ConcurrentAppend': + parameters: + api-version: '2016-11-01' + leaseId: 34adfa4f-cedf-4dc0-ba29-b6d1a69ab345 + op: CREATE + overwrite: false + path: /test_file_path + permission: '1' + streamContents: + test_key: /test_file_path + syncFlag: DATA + write: 'true' + responses: + '201': {} + x-ms-requestBody-index: '1' + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: Create + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file to + create. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The file contents to include when creating the file. This + parameter is optional, resulting in an empty file if not + specified. + extensions: + x-ms-requestBody-name: streamContents + isConstant: false + isRequired: false + location: body + modelType: + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + name: + fixed: false + raw: streamContents + serializedName: streamContents + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The indication of if the file should be overwritten. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: overwrite + serializedName: overwrite + - collectionFormat: none + defaultValue: + fixed: false + raw: CLOSE + documentation: + fixed: false + raw: >- + Optionally indicates what to do after completion of the create. + DATA indicates that more data will be sent immediately by the + client, the file handle should remain open/locked, and file + metadata (including file length, last modified time) should NOT + get updated. METADATA indicates that more data will be sent + immediately by the client, the file handle should remain + open/locked, and file metadata should get updated. CLOSE + indicates that the client is done sending data, the file handle + should be closed/unlocked, and file metadata should get updated. + extensions: + x-ms-enum: + modelAsString: false + name: SyncFlag + isConstant: false + isRequired: false + location: query + modelType: *ref_9 + name: + fixed: false + raw: syncFlag + serializedName: syncFlag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Optional unique GUID per file to ensure single writer semantics, + meaning that only clients that append to the file with the same + leaseId will be allowed to do so. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: leaseId + serializedName: leaseId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The octal representation of the unnamed user, mask and other + permissions that should be set for the file when created. If not + specified, it inherits these from the container. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: permission + serializedName: permission + - collectionFormat: none + defaultValue: + fixed: false + raw: 'true' + documentation: + fixed: false + raw: >- + Flag to skip redirection. When write=false or not specified, the + request is redirected. Submit another HTTP PUT request using the + URL in the Location header with the file data to be written. + When write=true, this redirection is skipped. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: write + serializedName: write + - collectionFormat: none + defaultValue: + fixed: false + raw: CREATE + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/octet-stream + responseContentTypes: + - application/json + responses: + Created: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_Create + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: Sets the Access Control List (ACL) for a file or folder. + extensions: + x-ms-examples: + Sets the Access Control List (ACL) for a file or folder: + parameters: + aclspec: 'user:2666084e-edd4-4276-9a8c-d1024a5e3d94:rwx' + api-version: '2016-11-01' + op: SETACL + path: /test_file_path + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: SetAcl + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory on which to set the ACL. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ACL spec included in ACL creation operations in the format + '[default:]user|group|other::r|-w|-x|-' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: aclspec + serializedName: aclspec + - collectionFormat: none + defaultValue: + fixed: false + raw: SETACL + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_SetAcl + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Modifies existing Access Control List (ACL) entries on a file or + folder. + extensions: + x-ms-examples: + Modifies existing Access Control List (ACL) entries on a file or folder: + parameters: + aclspec: 'user:2666084e-edd4-4276-9a8c-d1024a5e3d94:rwx' + api-version: '2016-11-01' + op: MODIFYACLENTRIES + path: /test_file_path + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: ModifyAclEntries + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory with the ACL being modified. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ACL specification included in ACL modification operations in + the format '[default:]user|group|other::r|-w|-x|-' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: aclspec + serializedName: aclspec + - collectionFormat: none + defaultValue: + fixed: false + raw: MODIFYACLENTRIES + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_ModifyAclEntries + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Removes existing Access Control List (ACL) entries for a file or + folder. + extensions: + x-ms-examples: + Removes existing Access Control List (ACL) entries for a file or folder: + parameters: + aclspec: 'user:2666084e-edd4-4276-9a8c-d1024a5e3d94' + api-version: '2016-11-01' + op: REMOVEACLENTRIES + path: /test_file_path + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: RemoveAclEntries + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory with the ACL being removed. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ACL spec included in ACL removal operations in the format + '[default:]user|group|other' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: aclspec + serializedName: aclspec + - collectionFormat: none + defaultValue: + fixed: false + raw: REMOVEACLENTRIES + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_RemoveAclEntries + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Removes the existing Default Access Control List (ACL) of the + specified directory. + extensions: + x-ms-examples: + Removes the existing Default Access Control List (ACL) of the specified directory: + parameters: + api-version: '2016-11-01' + op: REMOVEDEFAULTACL + path: /test_file_path + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: RemoveDefaultAcl + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the directory + with the default ACL being removed. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + raw: REMOVEDEFAULTACL + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_RemoveDefaultAcl + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Removes the existing Access Control List (ACL) of the specified file + or directory. + extensions: + x-ms-examples: + Removes the existing Access Control List (ACL) of the specified file or directory: + parameters: + api-version: '2016-11-01' + op: REMOVEACL + path: /test_file_path + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: RemoveAcl + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory with the ACL being removed. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + raw: REMOVEACL + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_RemoveAcl + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: >- + Gets Access Control List (ACL) entries for the specified file or + directory. + extensions: + x-ms-examples: + Gets Access Control List (ACL) entries for the specified file or directory: + parameters: + api-version: '2016-11-01' + op: GETACLSTATUS + path: /test_file_path + tooId: false + responses: + '200': + AclStatus: + entries: + - test_entry_1 + - test_entry_2 + group: test_group + owner: test_owner + permission: '1' + stickyBit: false + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetAclStatus + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory for which to get the ACL. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An optional switch to return friendly names in place of object + ID for ACL entries. tooid=false returns friendly names instead + of the AAD Object ID. Default value is true, returning AAD + object IDs. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: tooId + serializedName: tooId + - collectionFormat: none + defaultValue: + fixed: false + raw: GETACLSTATUS + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_16 + isNullable: true + returnType: + body: *ref_16 + isNullable: true + serializedName: FileSystem_GetAclStatus + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: 'Deletes the requested file or directory, optionally recursively.' + extensions: + x-ms-examples: + 'Deletes the requested file or directory, optionally recursively': + parameters: + api-version: '2016-11-01' + op: DELETE + path: /test_file_path + recursive: false + responses: + '200': + body: + boolean: false + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The optional switch indicating if the delete should be recursive + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: recursive + serializedName: recursive + - collectionFormat: none + defaultValue: + fixed: false + raw: DELETE + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_11 + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: FileSystem_Delete + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: Rename a file or directory. + extensions: + x-ms-examples: + Rename a file or directory: + parameters: + api-version: '2016-11-01' + destination: /test_destination_path + op: RENAME + path: /test_file_path + responses: + '200': + body: + boolean: false + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: Rename + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory to move/rename. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The path to move/rename the file or folder to + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: destination + serializedName: destination + - collectionFormat: none + defaultValue: + fixed: false + raw: RENAME + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_11 + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: FileSystem_Rename + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: Sets the owner of a file or directory. + extensions: + x-ms-examples: + Sets the owner of a file or directory: + parameters: + api-version: '2016-11-01' + group: test_group + op: SETOWNER + owner: test_owner + path: /test_file_path + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: SetOwner + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory for which to set the owner. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The AAD Object ID of the user owner of the file or directory. If + empty, the property will remain unchanged. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: owner + serializedName: owner + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The AAD Object ID of the group owner of the file or directory. + If empty, the property will remain unchanged. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: group + serializedName: group + - collectionFormat: none + defaultValue: + fixed: false + raw: SETOWNER + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_SetOwner + url: '/webhdfs/v1/{path}' + - defaultResponse: + body: *ref_6 + isNullable: true + deprecated: false + description: Sets the permission of the file or folder. + extensions: + x-ms-examples: + Sets the owner of a file or directory: + parameters: + api-version: '2016-11-01' + op: SETPERMISSION + path: /test_file_path + permission: rwx + responses: + '200': {} + group: + fixed: false + raw: FileSystem + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: SetPermission + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Data Lake Store path (starting with '/') of the file or + directory for which to set the permission. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: path + serializedName: path + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A string representation of the permission (i.e 'rwx'). If empty, + this property remains unchanged. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: permission + serializedName: permission + - collectionFormat: none + defaultValue: + fixed: false + raw: SETPERMISSION + documentation: + fixed: false + raw: The constant value for the operation. + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: op + serializedName: op + - clientProperty: *ref_10 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: FileSystem_SetPermission + url: '/webhdfs/v1/{path}' + name: + fixed: false + raw: FileSystem + nameForProperty: FileSystem + typeName: + fixed: false +properties: + - *ref_10 + - *ref_17 diff --git a/test/Expected/specs-mobileengagement/code-model-v1-yaml.yaml b/test/Expected/specs-mobileengagement/code-model-v1-yaml.yaml new file mode 100644 index 0000000..71b9072 --- /dev/null +++ b/test/Expected/specs-mobileengagement/code-model-v1-yaml.yaml @@ -0,0 +1,12614 @@ +--- +apiVersion: '2014-12-01' +baseUrl: 'https://management.azure.com' +documentation: Microsoft Azure Mobile Engagement REST APIs. +enumTypes: + - &ref_4 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: ProvisioningStates + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Creating + serializedName: Creating + - name: Succeeded + serializedName: Succeeded + - &ref_16 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: PushModes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: real-time + serializedName: real-time + - name: one-shot + serializedName: one-shot + - name: manual + serializedName: manual + - &ref_17 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: CampaignTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: text/plain + serializedName: text/plain + - name: text/html + serializedName: text/html + - name: only_notif + serializedName: only_notif + - name: text/base64 + serializedName: text/base64 + - &ref_18 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: DeliveryTimes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: any + serializedName: any + - name: background + serializedName: background + - name: session + serializedName: session + - &ref_19 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: NotificationTypes + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: system + serializedName: system + - name: popup + serializedName: popup + - &ref_23 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: CampaignStates + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: draft + serializedName: draft + - name: scheduled + serializedName: scheduled + - name: in-progress + serializedName: in-progress + - name: finished + serializedName: finished + - name: queued + serializedName: queued + - &ref_25 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: CampaignFeedbacks + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: pushed + serializedName: pushed + - name: replied + serializedName: replied + - name: actioned + serializedName: actioned + - name: exited + serializedName: exited + - &ref_26 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: AudienceOperators + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: EQ + serializedName: EQ + - name: LT + serializedName: LT + - name: GT + serializedName: GT + - name: LE + serializedName: LE + - name: GE + serializedName: GE + - &ref_34 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: CampaignType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Announcement + serializedName: Announcement + - name: DataPush + serializedName: DataPush + - name: NativePush + serializedName: NativePush + - name: Poll + serializedName: Poll + - &ref_35 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ExportState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Queued + serializedName: Queued + - name: Started + serializedName: Started + - name: Succeeded + serializedName: Succeeded + - name: Failed + serializedName: Failed + - &ref_36 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ExportType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Activity + serializedName: Activity + - name: Tag + serializedName: Tag + - name: Crash + serializedName: Crash + - name: Error + serializedName: Error + - name: Event + serializedName: Event + - name: Job + serializedName: Job + - name: Session + serializedName: Session + - name: Token + serializedName: Token + - name: Push + serializedName: Push + - &ref_33 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ExportFormat + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: JsonBlob + serializedName: JsonBlob + - name: CsvBlob + serializedName: CsvBlob + - &ref_39 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: JobStates + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Queued + serializedName: Queued + - name: Started + serializedName: Started + - name: Succeeded + serializedName: Succeeded + - name: Failed + serializedName: Failed + - &ref_49 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: CampaignKinds + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: announcements + serializedName: announcements + - name: polls + serializedName: polls + - name: dataPushes + serializedName: dataPushes + - name: nativePushes + serializedName: nativePushes +errorTypes: + - &ref_1 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ApiError + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ApiError_error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: ApiError_error + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + serializedName: ApiError +extensions: + security: + - azure_auth: + - user_impersonation +headerTypes: + - &ref_51 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Create operation. + name: + fixed: false + raw: Campaigns-Create-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: URL path to get the created campaign. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: Campaigns-Create-Headers + - &ref_63 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateActivitiesTask operation. + name: + fixed: false + raw: ExportTasks-CreateActivitiesTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateActivitiesTask-Headers + - &ref_65 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateCrashesTask operation. + name: + fixed: false + raw: ExportTasks-CreateCrashesTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateCrashesTask-Headers + - &ref_66 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateErrorsTask operation. + name: + fixed: false + raw: ExportTasks-CreateErrorsTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateErrorsTask-Headers + - &ref_67 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateEventsTask operation. + name: + fixed: false + raw: ExportTasks-CreateEventsTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateEventsTask-Headers + - &ref_68 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateJobsTask operation. + name: + fixed: false + raw: ExportTasks-CreateJobsTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateJobsTask-Headers + - &ref_69 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateSessionsTask operation. + name: + fixed: false + raw: ExportTasks-CreateSessionsTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateSessionsTask-Headers + - &ref_70 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateTagsTask operation. + name: + fixed: false + raw: ExportTasks-CreateTagsTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateTagsTask-Headers + - &ref_72 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateTokensTask operation. + name: + fixed: false + raw: ExportTasks-CreateTokensTask-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateTokensTask-Headers + - &ref_73 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateFeedbackTaskByDateRange operation. + name: + fixed: false + raw: ExportTasks-CreateFeedbackTaskByDateRange-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateFeedbackTaskByDateRange-Headers + - &ref_75 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for CreateFeedbackTaskByCampaign operation. + name: + fixed: false + raw: ExportTasks-CreateFeedbackTaskByCampaign-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location of the export task state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ExportTasks-CreateFeedbackTaskByCampaign-Headers + - &ref_78 + $type: CompositeType + containsConstantProperties: false + documentation: Defines headers for Create operation. + name: + fixed: false + raw: ImportTasks-Create-Headers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: URL path to get the created import job. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: Location + realPath: + - Location + serializedName: Location + serializedName: ImportTasks-Create-Headers +modelTypes: + - *ref_0 + - *ref_1 + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AppProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The application unique identifier. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: backendId + realPath: + - backendId + serializedName: backendId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The platform of the app. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: platform + realPath: + - platform + serializedName: platform + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The state of the application. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appState + realPath: + - appState + serializedName: appState + serializedName: AppProperties + - &ref_3 + $type: CompositeType + baseModelType: &ref_5 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: Resource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource name + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource type + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource location + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource tags + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + serializedName: Resource + containsConstantProperties: false + documentation: The Mobile Engagement App resource. + name: + fixed: false + raw: App + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: App + - &ref_45 + $type: CompositeType + containsConstantProperties: false + documentation: The list Apps operation response. + name: + fixed: false + raw: AppListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of Apps and their properties. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_3 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When the results are paged, the nextLink is the URI for the next + page of results. This property is empty when there are no additional + pages. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: AppListResult + - &ref_6 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AppCollectionProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Mobile Engagement AppCollection Properties. + extensions: + x-ms-enum: + modelAsString: true + name: ProvisioningStates + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_4 + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + serializedName: AppCollectionProperties + - &ref_7 + $type: CompositeType + baseModelType: *ref_5 + containsConstantProperties: false + documentation: The AppCollection resource. + name: + fixed: false + raw: AppCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_6 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: AppCollection + - &ref_41 + $type: CompositeType + containsConstantProperties: false + documentation: The list AppCollections operation response. + name: + fixed: false + raw: AppCollectionListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of AppCollections and their properties. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_7 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When the results are paged, the nextLink is the URI for the next + page of results. This property is empty when there are no additional + pages. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: AppCollectionListResult + - &ref_44 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: AppCollectionNameAvailability + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Available. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: available + realPath: + - available + serializedName: available + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: UnavailabilityReason. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: unavailabilityReason + realPath: + - unavailabilityReason + serializedName: unavailabilityReason + serializedName: AppCollectionNameAvailability + - &ref_46 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: SupportedPlatformsListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of supported platforms. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: platforms + realPath: + - platforms + serializedName: platforms + serializedName: SupportedPlatformsListResult + - *ref_5 + - &ref_21 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CampaignTestSavedParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Device identifier (as returned by the SDK). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: deviceId + realPath: + - deviceId + serializedName: deviceId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The language to test expressed using ISO 639-1 code. The default + language of the campaign will be used if the parameter is not + provided. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: lang + realPath: + - lang + serializedName: lang + serializedName: CampaignTestSavedParameters + - &ref_8 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Criterion + polymorphicDiscriminator: type + serializedName: Criterion + - &ref_9 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Filter + polymorphicDiscriminator: type + serializedName: Filter + - &ref_15 + $type: CompositeType + containsConstantProperties: false + documentation: > + Specify which users will be targeted by this campaign. By default, all + users will be targeted. If you set `pushMode` property to `manual`, the + only thing you can specify in the audience is the push quota filter. An + audience is a boolean expression made of criteria (variables) operators + (`not`, `and` or `or`) and parenthesis. Additionally, a set of filters can + be added to an audience. 65535 bytes max as per JSON encoding. + name: + fixed: false + raw: Campaign_audience + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Boolean expression made of criteria (variables) operators (`not`, + `and` or `or`) and parenthesis. Criterion names in the audience + expression must start with a capital letter and can only contain + alphanumeric (A-Z,a-z,0-9) and underscore (_) characters. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: expression + realPath: + - expression + serializedName: expression + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Criteria by name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_8 + name: + fixed: false + raw: criteria + realPath: + - criteria + serializedName: criteria + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Global filters applied to all devices. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_9 + name: + fixed: false + name: + fixed: false + raw: filters + realPath: + - filters + serializedName: filters + serializedName: Campaign_audience + - &ref_10 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: NotificationOptions + properties: + - collectionFormat: none + constraints: + MaxLength: '4000' + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Android 4.1+ only. Multi line message shown in expanded + notifications on Android 4.1+ devices. The `notificationType` + property must be set to `system`. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: bigText + realPath: + - bigText + serializedName: bigText + - collectionFormat: none + constraints: + MaxLength: '2000' + defaultValue: + fixed: false + documentation: + fixed: false + raw: | + URL of a remote image displayed in expanded notifications on + Android 4.1+ devices with the following constraints: + * The URL length is limited to 2000 characters. + * The image size must be less than 4 MiB. + * The following MIME types are supported: + ** image/png + ** image/jpeg + ** image/gif + ** image/webp + ** image/bmp + ** image/x-bmp + ** image/x-ms-bmp + * URL scheme must be HTTP or HTTPS (with valid SSL certificate). + * Incompatible with `bigText`, only one of the fields can be set. + * The `notificationType` property must be set to `system`. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: bigPicture + realPath: + - bigPicture + serializedName: bigPicture + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + iOS only. The name of a sound file in the application bundle. The + sound in this file is played as an alert. If the sound file doesn’t + exist or default is specified as the value, the default alert sound + is played. The audio must be in one of the audio data formats that + are compatible with system sounds. The `deliveryTime` property must + be set to `any` or `background`. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sound + realPath: + - sound + serializedName: sound + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The action text is the title of the right button of the alert or the + value of the unlock slider, where the value replaces 'unlock' in + 'slide to unlock'. 'View' (localized to the preferred language) is + used as the default value. The `deliveryTime` property must be set + to `any` or `background`. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: actionText + realPath: + - actionText + serializedName: actionText + serializedName: NotificationOptions + - &ref_14 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CampaignLocalization + properties: + - collectionFormat: none + constraints: + MaxLength: '2000' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Title of the notification. This field supports appInfo markers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: notificationTitle + realPath: + - notificationTitle + serializedName: notificationTitle + - collectionFormat: none + constraints: + MaxLength: '4000' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Message of the notification. This field supports appInfo markers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: notificationMessage + realPath: + - notificationMessage + serializedName: notificationMessage + - collectionFormat: none + constraints: + MaxLength: '65535' + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Optional image encoded in base 64. Usually included in the right + part of in app notifications (or as a banner if there is neither + text nor content icon). For Android system notifications, the image + is used as the large icon (displayed only on Android 3+). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: notificationImage + realPath: + - notificationImage + serializedName: notificationImage + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Additional platform specific options. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_10 + name: + fixed: false + raw: notificationOptions + realPath: + - notificationOptions + serializedName: notificationOptions + - collectionFormat: none + constraints: + MaxLength: '128' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Title of the announcement or poll. This field supports appInfo + markers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: title + realPath: + - title + serializedName: title + - collectionFormat: none + constraints: + MaxLength: '65535' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Body of the text/web announcement, poll or data push. This field + supports appInfo markers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: body + realPath: + - body + serializedName: body + - collectionFormat: none + constraints: + MaxLength: '64' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Text of the action button for text/web announcements and polls + (answer button). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: actionButtonText + realPath: + - actionButtonText + serializedName: actionButtonText + - collectionFormat: none + constraints: + MaxLength: '64' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Text of the exit button for text/web announcements and polls. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: exitButtonText + realPath: + - exitButtonText + serializedName: exitButtonText + - collectionFormat: none + constraints: + MaxLength: '2000' + defaultValue: + fixed: false + documentation: + fixed: false + raw: URL to launch when the announcement is actioned. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: actionUrl + realPath: + - actionUrl + serializedName: actionUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Native push payload. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: payload + realPath: + - payload + serializedName: payload + serializedName: CampaignLocalization + - &ref_12 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PollQuestionLocalization + properties: + - collectionFormat: none + constraints: + MaxLength: '256' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Title of the question. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: title + realPath: + - title + serializedName: title + serializedName: PollQuestionLocalization + - &ref_11 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: PollQuestionChoiceLocalization + properties: + - collectionFormat: none + constraints: + MaxLength: '256' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Title of the choice. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: title + realPath: + - title + serializedName: title + serializedName: PollQuestionChoiceLocalization + - &ref_13 + $type: CompositeType + baseModelType: *ref_11 + containsConstantProperties: false + name: + fixed: false + raw: PollQuestionChoice + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unique identifier of the choice. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Poll choices can be localized using an optional JSON object. The + JSON key is a two-character language code as specified by the ISO + 639-1 standard. The corresponding value is an object containing the + localizable property title. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_11 + name: + fixed: false + raw: localization + realPath: + - localization + serializedName: localization + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + A flag indicating if this choice is the default choice for the + associated question. Only one choice in the array can have this + value set to true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isDefault + realPath: + - isDefault + serializedName: isDefault + serializedName: PollQuestionChoice + - &ref_20 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + name: + fixed: false + raw: PollQuestion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unique identifier of the question. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Poll questions can be localized using an optional JSON object. The + JSON key is a two-character language code as specified by the ISO + 639-1 standard. The corresponding value is an object containing the + localizable property title. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_12 + name: + fixed: false + raw: localization + realPath: + - localization + serializedName: localization + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of possible choices for this question. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_13 + name: + fixed: false + name: + fixed: false + raw: choices + realPath: + - choices + serializedName: choices + serializedName: PollQuestion + - &ref_22 + $type: CompositeType + baseModelType: *ref_14 + containsConstantProperties: false + name: + fixed: false + raw: Campaign + properties: + - collectionFormat: none + constraints: + MaxLength: '64' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unique name of the campaign. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Specify which users will be targeted by this campaign. By default, + all users will be targeted. If you set `pushMode` property to + `manual`, the only thing you can specify in the audience is the push + quota filter. An audience is a boolean expression made of criteria + (variables) operators (`not`, `and` or `or`) and parenthesis. + Additionally, a set of filters can be added to an audience. 65535 + bytes max as per JSON encoding. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_15 + name: + fixed: false + raw: audience + realPath: + - audience + serializedName: audience + - collectionFormat: none + constraints: + MaxLength: '64' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Category of the campaign. Categories can be used on the application + side to customize campaigns. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: category + realPath: + - category + serializedName: category + - collectionFormat: none + defaultValue: + fixed: false + raw: real-time + documentation: + fixed: false + raw: > + Announcements/polls only. Defines how the campaign is pushed. Valid + values are: * `real-time`: Never ending campaign, the campaign will + be delivered to your existing users and also to your new users. * + `one-shot`: In this mode, the campaign will be delivered only to + your existing users (campaign will stop after that). * `manual`: In + this mode, the campaign will not be pushed automatically to devices. + You will have to use the Push campaign command to push the campaign + to your end-users. Campaigns can be pushed multiple times to the + same device. + extensions: + x-ms-enum: + modelAsString: true + name: PushModes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_16 + name: + fixed: false + raw: pushMode + realPath: + - pushMode + serializedName: pushMode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Applicable only to announcements and data pushes. Type of + announcement. Valid values are: * `text/plain`: Text-only + announcement: `body` property should only contain plain text. * + `text/html`: HTML announcement: `body` attribute can contain HTML + code. * `only_notif`: Notification-only announcement. With this kind + of announcements, the `body`, `title`, `actionButtonText` and + `exitButtonText` are ignored. Type of data push. Valid values are: * + `text/plain`: Text only data push: `body` property must be plain + text. * `text/base64`: Base 64 data push: `body` property must be + encoded in base 64. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_17 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Announcements/polls only. Defines when the campaign should be + delivered. Valid values are: * `any`: Campaign will be delivered as + soon as possible. * `background`: iOS only. Campaign will be only + delivered when the application is in background (out of app). * + `session`: Campaign will be delivered when the application is + running. + extensions: + x-ms-enum: + modelAsString: true + name: DeliveryTimes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_18 + name: + fixed: false + raw: deliveryTime + realPath: + - deliveryTime + serializedName: deliveryTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Announcements/polls only. Array containing the list of activities in + which the campaign can be delivered. deliveryTime must be set to + session. If the platform is iOS, this option can also be set if + deliveryTime is set to any. In that case, if the campaign is + received when the application is launched, it will be delivered only + in the specified list of activities. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: deliveryActivities + realPath: + - deliveryActivities + serializedName: deliveryActivities + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the campaign should be started. The date shall + conform to the following format: `yyyy-MM-ddTHH:mm:ssZ`. * If you + set pushMode property to manual, this attribute will be ignored. * + If you set pushMode property to one-shot, then the timezone + attribute must be specified. Example: `2011-11-21 15:23Z` + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the campaign should be finished. The date shall + conform to the following format: `yyyy-MM-ddTHH:mm:ssZ`. Example: + `2011-11-21 15:23Z` + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The id of the time zone to use for the startTime and endTime dates. + If not provided, the two date attributes will be expressed using the + device timezone. Example: America/Los_Angeles + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timezone + realPath: + - timezone + serializedName: timezone + - collectionFormat: none + defaultValue: + fixed: false + raw: popup + documentation: + fixed: false + raw: > + Android only. Defines how the notification should be displayed. + Valid values are: * `system`: Display the notification using a + standard system notification. * `popup`: Display the notification + using a in-app banner notification. + extensions: + x-ms-enum: + modelAsString: true + name: NotificationTypes + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_19 + name: + fixed: false + raw: notificationType + realPath: + - notificationType + serializedName: notificationType + - collectionFormat: none + defaultValue: + fixed: false + raw: 'true' + documentation: + fixed: false + raw: >- + A flag indicating whether or not you want to display the resource + icon in notification content. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: notificationIcon + realPath: + - notificationIcon + serializedName: notificationIcon + - collectionFormat: none + defaultValue: + fixed: false + raw: 'true' + documentation: + fixed: false + raw: >- + A flag indicating whether or not you want the notification to be + closeable. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: notificationCloseable + realPath: + - notificationCloseable + serializedName: notificationCloseable + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Android only. A flag indicating whether or not you want the system + notification to make a vibration. The notificationType property must + be set to system. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: notificationVibrate + realPath: + - notificationVibrate + serializedName: notificationVibrate + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: > + * `Android`: A flag indicating whether or not you want the system + notification to make a sound. The `notificationType` property must + be set to `system`. * `iOS`: A flag indicating whether or not you + want the native Apple Push notification to make a sound. The + `deliveryTime` property must be set to `any` or `background`. This + will play the 'default' sound. If you want to play a custom sound, + see the `notificationOptions` property. * `Windows`: A flag + indicating whether or not you want the native Windows Notification + Service to make a sound. The `deliveryTime` property must be set to + `any`. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: notificationSound + realPath: + - notificationSound + serializedName: notificationSound + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: > + A flag indicating whether or not you want the native Apple Push + notification to update the badge icon to the number of unread + messages. The `deliveryTime` property must be set to `any` or + `background`. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: notificationBadge + realPath: + - notificationBadge + serializedName: notificationBadge + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Push campaigns can be localized using an optional JSON object. The + JSON key is a two-character language code as specified by the ISO + 639-1 standard. The corresponding value is an object containing the + localizable properties. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_14 + name: + fixed: false + raw: localization + realPath: + - localization + serializedName: localization + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Poll questions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_20 + name: + fixed: false + name: + fixed: false + raw: questions + realPath: + - questions + serializedName: questions + serializedName: Campaign + - &ref_54 + $type: CompositeType + baseModelType: *ref_21 + containsConstantProperties: false + name: + fixed: false + raw: CampaignTestNewParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_22 + name: + fixed: false + raw: data + realPath: + - data + serializedName: data + serializedName: CampaignTestNewParameters + - &ref_55 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CampaignPushParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Device identifiers to push as a JSON array of strings. Note that if + you want to push the same campaign several times to the same device, + you need to make several API calls. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: deviceIds + realPath: + - deviceIds + serializedName: deviceIds + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Alternative campaign's content to use instead of the referenced + campaign. All campaign's properties can be overridden except for the + following: `name`, `manualPush`, `audience`, `startTime` and + `timezone`. `endTime` can be overridden while keeping original + `timezone` parameter. The effect is to change the client side + expiration of the received campaign for the specific devices. If + your campaign is a *poll*, the provided data should contain the same + number of questions and choices that the one you created with the + create command. Please note that all the push messages created using + this parameter will expire after 4 weeks at maximum (`endTime` + property of the campaign will be used if lower than 4 weeks in the + future). + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_22 + name: + fixed: false + raw: data + realPath: + - data + serializedName: data + serializedName: CampaignPushParameters + - &ref_24 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CampaignState + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'State of the campaign, or ''queued'' when testing a campaign.' + extensions: + x-ms-enum: + modelAsString: true + name: CampaignStates + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_23 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + serializedName: CampaignState + - &ref_27 + $type: CompositeType + baseModelType: *ref_24 + containsConstantProperties: false + name: + fixed: false + raw: CampaignStateResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: CampaignStateResult + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices based on their carrier name. + extensions: + x-ms-discriminator-value: carrier-name + name: + fixed: false + raw: CarrierNameCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Carrier name value. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: carrier-name + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices based on their carrier country. + extensions: + x-ms-discriminator-value: carrier-country + name: + fixed: false + raw: CarrierCountryCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Two-characters country code (ISO 3166-1). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: carrier-country + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices based on their firmware version. + extensions: + x-ms-discriminator-value: firmware-version + name: + fixed: false + raw: FirmwareVersionCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Firmware version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: firmware-version + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices based on the device manufacturer. + extensions: + x-ms-discriminator-value: device-manufacturer + name: + fixed: false + raw: DeviceManufacturerCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The device manufacturer. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: device-manufacturer + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices based on the device model. + extensions: + x-ms-discriminator-value: device-model + name: + fixed: false + raw: DeviceModelCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The device model. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: device-model + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: >- + Used to target devices based on the version of the application they are + using. + extensions: + x-ms-discriminator-value: application-version + name: + fixed: false + raw: ApplicationVersionCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The application version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: application-version + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices based their network type. + extensions: + x-ms-discriminator-value: network-type + name: + fixed: false + raw: NetworkTypeCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The network type (Wifi, Mobile...).' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: network-type + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices based on the language of their device. + extensions: + x-ms-discriminator-value: language + name: + fixed: false + raw: LanguageCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Two character language code (ISO 639-1). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: language + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices based on the screen resolution of their device. + extensions: + x-ms-discriminator-value: screen-size + name: + fixed: false + raw: ScreenSizeCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Screen size using the following format WIDTH**x**HEIGHT. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: screen-size + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices based on their last know area. + extensions: + x-ms-discriminator-value: location + name: + fixed: false + raw: LocationCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Two character country code where the user is located (ISO 3166-1). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: country + realPath: + - country + serializedName: country + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An administrative region of the country, such as a state or + province. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: region + realPath: + - region + serializedName: region + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'A locality within the administrative region, such as a town or city.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: locality + realPath: + - locality + serializedName: locality + serializedName: location + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: > + Used to target devices based on a specific region. A center point (defined + by a latitude and longitude) and a radius form the boundary for the + region. This criterion will be met when the user crosses the boundaries of + the region. + extensions: + x-ms-discriminator-value: geo-fencing + name: + fixed: false + raw: GeoFencingCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The latitude of the central point of the region. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: lat + realPath: + - lat + serializedName: lat + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The longitude of the central point of the region. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: lon + realPath: + - lon + serializedName: lon + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The radius of the central point of the region, in meters.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: radius + realPath: + - radius + serializedName: radius + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of minutes before device location is considered to be + expired. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: expiration + realPath: + - expiration + serializedName: expiration + serializedName: geo-fencing + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices who received an announcement. + extensions: + x-ms-discriminator-value: announcement-feedback + name: + fixed: false + raw: AnnouncementFeedbackCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The unique identifier of the announcement. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: content-id + realPath: + - content-id + serializedName: content-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Action that was performed on the announcement. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignFeedbacks + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_25 + name: + fixed: false + raw: action + realPath: + - action + serializedName: action + serializedName: announcement-feedback + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices who received a poll. + extensions: + x-ms-discriminator-value: poll-feedback + name: + fixed: false + raw: PollFeedbackCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The unique identifier of the poll. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: content-id + realPath: + - content-id + serializedName: content-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Action that was performed on the poll. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignFeedbacks + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_25 + name: + fixed: false + raw: action + realPath: + - action + serializedName: action + serializedName: poll-feedback + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices who answered X to a given question. + extensions: + x-ms-discriminator-value: poll-answer-feedback + name: + fixed: false + raw: PollAnswerFeedbackCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The unique identifier of the poll. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: content-id + realPath: + - content-id + serializedName: content-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The unique identifier of the choice. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: choice-id + realPath: + - choice-id + serializedName: choice-id + serializedName: poll-answer-feedback + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Used to target devices who received a data push. + extensions: + x-ms-discriminator-value: datapush-feedback + name: + fixed: false + raw: DatapushFeedbackCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The unique identifier of the data push. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: content-id + realPath: + - content-id + serializedName: content-id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + Action that was performed on the data push (action depends on the + return value in the callbacks you declared in the client code). + extensions: + x-ms-enum: + modelAsString: true + name: CampaignFeedbacks + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_25 + name: + fixed: false + raw: action + realPath: + - action + serializedName: action + serializedName: datapush-feedback + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Target devices based on an existing segment. + extensions: + x-ms-discriminator-value: segment + name: + fixed: false + raw: SegmentCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Segment identifier. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If value is true, the criterion will target users that are NOT part + of the segment. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: exclude + realPath: + - exclude + serializedName: exclude + serializedName: segment + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Target devices based on a string tag value. + extensions: + x-ms-discriminator-value: string-tag + name: + fixed: false + raw: StringTagCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the custom tag. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A custom string to match for tag value (? and * characters can be + used to perform wildcard matching). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: string-tag + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Target devices based on a date tag value. + extensions: + x-ms-discriminator-value: date-tag + name: + fixed: false + raw: DateTagCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the custom tag. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + It can be either: * an absolute date using yyyy-MM-dd format (e.g. + 1969-12-07 stands for 7 Dec 1969). * an offset in days relative to + the current day (`TODAY` + `value`). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + comparison operator: `EQ` (equal to), `LT` (less than), `GT` + (greater than), `LE` (less than or equal to) or `GE` (greater than + or equal to). + extensions: + x-ms-enum: + modelAsString: true + name: AudienceOperators + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: op + realPath: + - op + serializedName: op + serializedName: date-tag + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Target devices based on an integer tag value. + extensions: + x-ms-discriminator-value: integer-tag + name: + fixed: false + raw: IntegerTagCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the custom tag. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A custom integer value to match. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + comparison operator: `EQ` (equal to), `LT` (less than), `GT` + (greater than), `LE` (less than or equal to) or `GE` (greater than + or equal to). + extensions: + x-ms-enum: + modelAsString: true + name: AudienceOperators + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: op + realPath: + - op + serializedName: op + serializedName: integer-tag + - $type: CompositeType + baseModelType: *ref_8 + containsConstantProperties: false + documentation: Target devices based on a boolean tag value. + extensions: + x-ms-discriminator-value: boolean-tag + name: + fixed: false + raw: BooleanTagCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the custom tag. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A custom boolean value to match. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: boolean-tag + - $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: Send only to a maximum of max users. + extensions: + x-ms-discriminator-value: engage-subset + name: + fixed: false + raw: EngageSubsetFilter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + An integer value representing the maximum users that should be + pushed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: max + realPath: + - max + serializedName: max + serializedName: engage-subset + - $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: 'Send only to users whose first app use is more than {threshold} days old.' + extensions: + x-ms-discriminator-value: engage-old-users + name: + fixed: false + raw: EngageOldUsersFilter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An integer value representing the threshold to apply on this filter. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: threshold + realPath: + - threshold + serializedName: threshold + serializedName: engage-old-users + - $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: 'Send only to users whose first app use is less than {threshold} days old.' + extensions: + x-ms-discriminator-value: engage-new-users + name: + fixed: false + raw: EngageNewUsersFilter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An integer value representing the threshold to apply on this filter. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: threshold + realPath: + - threshold + serializedName: threshold + serializedName: engage-new-users + - $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: 'Send only to users who have used the app in the last {threshold} days.' + extensions: + x-ms-discriminator-value: engage-active-users + name: + fixed: false + raw: EngageActiveUsersFilter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An integer value representing the threshold to apply on this filter. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: threshold + realPath: + - threshold + serializedName: threshold + serializedName: engage-active-users + - $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: 'Send only to users who haven''t used the app in the last {threshold} days.' + extensions: + x-ms-discriminator-value: engage-idle-users + name: + fixed: false + raw: EngageIdleUsersFilter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An integer value representing the threshold to apply on this filter. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: threshold + realPath: + - threshold + serializedName: threshold + serializedName: engage-idle-users + - $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: Engage only users with native push enabled. + extensions: + x-ms-discriminator-value: native-push-enabled + name: + fixed: false + raw: NativePushEnabledFilter + serializedName: native-push-enabled + - $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: Engage only users for whom the push quota is not reached. + extensions: + x-ms-discriminator-value: push-quota + name: + fixed: false + raw: PushQuotaFilter + serializedName: push-quota + - $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: > + Send only to users who have some app info set. This is a special filter + that is automatically added if your campaign contains appInfo parameters. + It is not intended to be public and should not be used as it could be + removed or replaced by the API. + extensions: + x-ms-discriminator-value: app-info + name: + fixed: false + raw: AppInfoFilter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: An array containing all the required appInfo. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: appInfo + realPath: + - appInfo + serializedName: appInfo + serializedName: app-info + - &ref_28 + $type: CompositeType + baseModelType: *ref_27 + containsConstantProperties: false + name: + fixed: false + raw: CampaignListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the campaign. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the campaign was activated (Not present if not yet + activated). The date conforms to the following format: + `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: activatedDate + realPath: + - activatedDate + serializedName: activatedDate + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the campaign was finished (Not present if not yet + finished). The date conforms to the following format: + `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: finishedDate + realPath: + - finishedDate + serializedName: finishedDate + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the campaign should be started if specified. The + date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as + specified by the ISO 8601 standard. Applicable only to announcements + and polls. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the campaign should be finished if specified. The + date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as + specified by the ISO 8601 standard. Applicable only to announcements + and polls. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The id of the time zone to use for the `startTime` and `endTime` + dates. If not provided, the two date attributes are referencing to + the device timezone. Applicable only to announcements and polls. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timezone + realPath: + - timezone + serializedName: timezone + serializedName: CampaignListResult + - &ref_53 + $type: CompositeType + baseModelType: *ref_22 + containsConstantProperties: false + name: + fixed: false + raw: CampaignResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'State of the campaign, or ''queued'' when testing a campaign.' + extensions: + x-ms-enum: + modelAsString: true + name: CampaignStates + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_23 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the campaign was activated (Not present if not yet + activated). The date conforms to the following format: + yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: activatedDate + realPath: + - activatedDate + serializedName: activatedDate + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the campaign was finished (Not present if not yet + finished). The date conforms to the following format: + yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: finishedDate + realPath: + - finishedDate + serializedName: finishedDate + serializedName: CampaignResult + - &ref_56 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CampaignPushResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + A JSON array containing all identifiers that have been rejected. A + device can be rejected for the following reasons: * The device + hasn’t reported any session yet. * The device is over quota (if a + push quota filter is applied on your campaign). Please note that if + the request parameters are valid but all the specified devices are + rejected, the status code is still `200` with a response including + all the devices as being rejected. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: invalidDeviceIds + realPath: + - invalidDeviceIds + serializedName: invalidDeviceIds + serializedName: CampaignPushResult + - &ref_57 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: CampaignStatisticsResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Number of times the campaign was registered to be pushed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: queued + realPath: + - queued + serializedName: queued + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Number of pushes performed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: pushed + realPath: + - pushed + serializedName: pushed + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Total number of native pushes. Information only available on + Android, iOS, Windows Phone and Windows applications. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: pushed-native + realPath: + - pushed-native + serializedName: pushed-native + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Number of C2DM/GCM pushes (available only on Android applications). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: pushed-native-google + realPath: + - pushed-native-google + serializedName: pushed-native-google + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Number of ADM pushes (available only on Android applications). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: pushed-native-adm + realPath: + - pushed-native-adm + serializedName: pushed-native-adm + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the campaign was received by the application (Not + present in case of a native-push). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: delivered + realPath: + - delivered + serializedName: delivered + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the campaign was dropped by the application. It can + happen if the SDK failed to parse the campaign payload or if an + error occurred while trying to notify the end-user (Not present in + case of a native-push). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: dropped + realPath: + - dropped + serializedName: dropped + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the system notification was displayed (Not present + in case of a data-push or a native-push). On Android it corresponds + to a status bar notification. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: system-notification-displayed + realPath: + - system-notification-displayed + serializedName: system-notification-displayed + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the in-app notification was displayed (Not present + in case of a data-push or a native-push). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: in-app-notification-displayed + realPath: + - in-app-notification-displayed + serializedName: in-app-notification-displayed + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the campaign’s content view was displayed (Not + present in case of a notification-only announcement, a data-push or + a native-push). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: content-displayed + realPath: + - content-displayed + serializedName: content-displayed + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the system notification (On Android it corresponds + to a status bar notification. On iOS, it is the Apple Push + notification) was actioned. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: system-notification-actioned + realPath: + - system-notification-actioned + serializedName: system-notification-actioned + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the system notification was exited (Not present in + case of a data-push or a native-push). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: system-notification-exited + realPath: + - system-notification-exited + serializedName: system-notification-exited + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the in-app notification was actioned (Not present in + case of a data-push or a native-push). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: in-app-notification-actioned + realPath: + - in-app-notification-actioned + serializedName: in-app-notification-actioned + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the in-app notification was exited (Not present in + case of a data-push or a native-push). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: in-app-notification-exited + realPath: + - in-app-notification-exited + serializedName: in-app-notification-exited + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the campaign’s content view was actioned (Not + present in case of a notification-only announcement or a + native-push). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: content-actioned + realPath: + - content-actioned + serializedName: content-actioned + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of times the campaign’s content view was exited (Not present + in case of a notification-only announcement or a native-push). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: content-exited + realPath: + - content-exited + serializedName: content-exited + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Poll specific statistics. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: answers + realPath: + - answers + serializedName: answers + serializedName: CampaignStatisticsResult + - &ref_50 + $type: CompositeType + containsConstantProperties: false + documentation: The campaigns list result. + name: + fixed: false + raw: CampaignsListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of campaigns. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_28 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When using `top` parameter and if partial results are returned, this + property describes a URI path to get the next results. This property + is not set when reaching the last page. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: CampaignsListResult + - &ref_29 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: DeviceMeta + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + First time the device used the application in milliseconds since + January 1st, 1970 UTC. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: firstSeen + realPath: + - firstSeen + serializedName: firstSeen + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Last time the device used the application in milliseconds since + January 1st, 1970 UTC. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: lastSeen + realPath: + - lastSeen + serializedName: lastSeen + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Timestamp corresponding to the info object in milliseconds since + January 1st, 1970 UTC. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: lastInfo + realPath: + - lastInfo + serializedName: lastInfo + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Timestamp corresponding to the location object in milliseconds since + January 1st, 1970 UTC. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: lastLocation + realPath: + - lastLocation + serializedName: lastLocation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Boolean indicating if native push notifications (like Android’s GCM + or Apple’s APNS) are enabled for the application. This boolean is + set to true when the application registers successfully to the + native push service, and set to false when the native push service + reports to Mobile Engagement that the application can no longer be + pushed (which means that it has been uninstalled). This report is + performed a few hours after Mobile Engagement has tried to perform a + native push to a device on which the application has been + uninstalled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: nativePushEnabled + realPath: + - nativePushEnabled + serializedName: nativePushEnabled + serializedName: DeviceMeta + - &ref_30 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: DeviceQueryResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The device result. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: deviceId + realPath: + - deviceId + serializedName: deviceId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application usage data. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_29 + name: + fixed: false + raw: meta + realPath: + - meta + serializedName: meta + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Also known as tags, a key-value set as a JSON object.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appInfo + realPath: + - appInfo + serializedName: appInfo + serializedName: DeviceQueryResult + - &ref_58 + $type: CompositeType + containsConstantProperties: false + documentation: The campaigns list result. + name: + fixed: false + raw: DevicesQueryResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of devices. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_30 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If partial results are returned, this property describes a URI path + to get the next result page. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: DevicesQueryResult + - &ref_31 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: DeviceInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Phone model. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: phoneModel + realPath: + - phoneModel + serializedName: phoneModel + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Phone manufacturer + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: phoneManufacturer + realPath: + - phoneManufacturer + serializedName: phoneManufacturer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Firmware version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: firmwareVersion + realPath: + - firmwareVersion + serializedName: firmwareVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Firmware name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: firmwareName + realPath: + - firmwareName + serializedName: firmwareName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Android API level. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: androidAPILevel + realPath: + - androidAPILevel + serializedName: androidAPILevel + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Carrier country. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: carrierCountry + realPath: + - carrierCountry + serializedName: carrierCountry + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Locale code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: locale + realPath: + - locale + serializedName: locale + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Carrier name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: carrierName + realPath: + - carrierName + serializedName: carrierName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Network type. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: networkType + realPath: + - networkType + serializedName: networkType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Network sub-type. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: networkSubtype + realPath: + - networkSubtype + serializedName: networkSubtype + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application version name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: applicationVersionName + realPath: + - applicationVersionName + serializedName: applicationVersionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application version code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: applicationVersionCode + realPath: + - applicationVersionCode + serializedName: applicationVersionCode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The offset in minutes from UTC for the device time zone, including + daylight savings time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: timeZoneOffset + realPath: + - timeZoneOffset + serializedName: timeZoneOffset + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SDK version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: serviceVersion + realPath: + - serviceVersion + serializedName: serviceVersion + serializedName: DeviceInfo + - &ref_32 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: DeviceLocation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ISO 3166 two-letter country code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: countrycode + realPath: + - countrycode + serializedName: countrycode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'An administrative region of the nation, such as a state or province.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: region + realPath: + - region + serializedName: region + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'A locality within the administrative region, such as a town or city.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: locality + realPath: + - locality + serializedName: locality + serializedName: DeviceLocation + - &ref_59 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Device + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The device result. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: deviceId + realPath: + - deviceId + serializedName: deviceId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application usage data. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_29 + name: + fixed: false + raw: meta + realPath: + - meta + serializedName: meta + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Last technical data received (concerning device, system, network and + application identification). + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_31 + name: + fixed: false + raw: info + realPath: + - info + serializedName: info + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Last geo-location data received. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_32 + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Also known as tags, a key-value set as a JSON object.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appInfo + realPath: + - appInfo + serializedName: appInfo + serializedName: Device + - &ref_60 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: DeviceTagsParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + A JSON object describing the set of tags to record for a set of + users. Each key is a device/user identifier, each value is itself a + key/value set: the tags to set for the specified device/user + identifier. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: 'If this parameter is `true`, tags with a null value will be deleted.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: deleteOnNull + realPath: + - deleteOnNull + serializedName: deleteOnNull + serializedName: DeviceTagsParameters + - &ref_61 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: DeviceTagsResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + A JSON array containing all identifiers that have been rejected. + Please note that if the request parameters are valid but all the + specified devices are rejected, the status code is still `200` with + a response including all the devices as being rejected. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: invalidIds + realPath: + - invalidIds + serializedName: invalidIds + serializedName: DeviceTagsResult + - $type: CompositeType + containsConstantProperties: false + documentation: Options to control export generation. + name: + fixed: false + raw: exportOptions + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: exportUserId + realPath: + - exportUserId + serializedName: exportUserId + serializedName: exportOptions + - &ref_64 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: dateRangeExportTaskParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: uri + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: containerUrl + realPath: + - containerUrl + serializedName: containerUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A description of the export task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The RFC3339 full-date of the start of the period for which data is + exported. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: startDate + realPath: + - startDate + serializedName: startDate + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The RFC3339 full-date of the end of the period for which data is + exported. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: endDate + realPath: + - endDate + serializedName: endDate + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The format of the exported data. + extensions: + x-ms-enum: + modelAsString: false + name: ExportFormat + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_33 + name: + fixed: false + raw: exportFormat + realPath: + - exportFormat + serializedName: exportFormat + serializedName: dateRangeExportTaskParameter + - &ref_71 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: exportTaskParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: uri + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: containerUrl + realPath: + - containerUrl + serializedName: containerUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A description of the export task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The format of the exported data. + extensions: + x-ms-enum: + modelAsString: false + name: ExportFormat + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_33 + name: + fixed: false + raw: exportFormat + realPath: + - exportFormat + serializedName: exportFormat + serializedName: exportTaskParameter + - &ref_76 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: feedbackByCampaignParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: uri + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: containerUrl + realPath: + - containerUrl + serializedName: containerUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A description of the export task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: CampaignType + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_34 + name: + fixed: false + raw: campaignType + realPath: + - campaignType + serializedName: campaignType + - collectionFormat: none + constraints: + MinItems: '1' + defaultValue: + fixed: false + documentation: + fixed: false + raw: A list of campaign identifiers. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + format: long + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + name: + fixed: false + raw: campaignIds + realPath: + - campaignIds + serializedName: campaignIds + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The format of the exported data. + extensions: + x-ms-enum: + modelAsString: false + name: ExportFormat + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_33 + name: + fixed: false + raw: exportFormat + realPath: + - exportFormat + serializedName: exportFormat + serializedName: feedbackByCampaignParameter + - &ref_74 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: feedbackByDateRangeParameter + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: uri + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: containerUrl + realPath: + - containerUrl + serializedName: containerUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A description of the export task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: CampaignType + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_34 + name: + fixed: false + raw: campaignType + realPath: + - campaignType + serializedName: campaignType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The RFC3339 date-time start of the period for inclusion of active + campaigns. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: campaignWindowStart + realPath: + - campaignWindowStart + serializedName: campaignWindowStart + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The RFC3339 date-time end of the period for inclusion of active + campaigns. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: campaignWindowEnd + realPath: + - campaignWindowEnd + serializedName: campaignWindowEnd + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The format of the exported data. + extensions: + x-ms-enum: + modelAsString: false + name: ExportFormat + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_33 + name: + fixed: false + raw: exportFormat + realPath: + - exportFormat + serializedName: exportFormat + serializedName: feedbackByDateRangeParameter + - &ref_37 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: exportTaskResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unique identifier of the export task. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A description of the export task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: ExportState + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_35 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The RFC3339 date-time the export task was created. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: dateCreated + realPath: + - dateCreated + serializedName: dateCreated + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The RFC3339 date-time the export task was completed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: dateCompleted + realPath: + - dateCompleted + serializedName: dateCompleted + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + modelAsString: false + name: ExportType + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_36 + name: + fixed: false + raw: exportType + realPath: + - exportType + serializedName: exportType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Details of errors encountered during the export, if any.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: errorDetails + realPath: + - errorDetails + serializedName: errorDetails + serializedName: exportTaskResult + - &ref_62 + $type: CompositeType + containsConstantProperties: false + documentation: Gets a paged list of ExportTasks. + name: + fixed: false + raw: exportTaskListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of export tasks. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_37 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When the results are paged, the nextLink is the URI for the next + page of results. This property is empty when there are no additional + pages. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: exportTaskListResult + - &ref_38 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: importTask + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A shared Access Signature (SAS) Storage URI where the job results + will be retrieved from. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: storageUrl + realPath: + - storageUrl + serializedName: storageUrl + serializedName: importTask + - &ref_40 + $type: CompositeType + baseModelType: *ref_38 + containsConstantProperties: false + name: + fixed: false + raw: importTaskResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unique identifier of the import task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The current state of the import task. + extensions: + x-ms-enum: + modelAsString: true + name: JobStates + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_39 + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the import job was created. + + The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as + specified by the ISO 8601 standard. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: dateCreated + realPath: + - dateCreated + serializedName: dateCreated + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: > + The date at which the import job completed (Not present if not yet + completed). + + The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as + specified by the ISO 8601 standard. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: dateCompleted + realPath: + - dateCompleted + serializedName: dateCompleted + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Details of any errors encountered during the import, if any.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: errorDetails + realPath: + - errorDetails + serializedName: errorDetails + serializedName: importTaskResult + - &ref_77 + $type: CompositeType + containsConstantProperties: false + documentation: Gets a paged list of import tasks. + name: + fixed: false + raw: importTaskListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The list of import task. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_40 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When the results are paged, the nextLink is the URI for the next + page of results. This property is empty when there are no additional + pages. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: importTaskListResult +modelsName: Models +name: EngagementManagementClient +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Lists app collections in a subscription. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: AppCollections + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: &ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify + Microsoft Azure subscription. The subscription ID forms part + of the URI for every service call. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: &ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_41 + isNullable: true + returnType: + body: *ref_41 + isNullable: true + serializedName: AppCollections_List + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.MobileEngagement/appCollections + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Checks availability of an app collection name in the Engagement + domain. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: AppCollections + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CheckNameAvailability + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_44 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_44 + isNullable: true + returnType: + body: *ref_44 + isNullable: true + serializedName: AppCollections_CheckNameAvailability + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.MobileEngagement/checkAppCollectionNameAvailability + name: + fixed: false + raw: AppCollections + nameForProperty: AppCollections + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Lists apps in an appCollection. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: Apps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: &ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + realPath: + - resourceGroupName + serializedName: resourceGroupName + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: &ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + realPath: + - appCollection + serializedName: appCollection + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_45 + isNullable: true + returnType: + body: *ref_45 + isNullable: true + serializedName: Apps_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps + name: + fixed: false + raw: Apps + nameForProperty: Apps + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Lists supported platforms for Engagement applications. + group: + fixed: false + raw: SupportedPlatforms + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_46 + isNullable: true + returnType: + body: *ref_46 + isNullable: true + serializedName: SupportedPlatforms_List + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.MobileEngagement/supportedPlatforms + name: + fixed: false + raw: SupportedPlatforms + nameForProperty: SupportedPlatforms + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Get the list of campaigns. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: &ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + realPath: + - appName + serializedName: appName + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Control paging of campaigns, start results at the given offset, + defaults to 0 (1st page of data). + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $skip + serializedName: $skip + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Control paging of campaigns, number of campaigns to return with + each call. It returns all campaigns by default. When specifying + $top parameter, the response contains a `nextLink` property + describing the path to get the next page if there are more + results. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $top + serializedName: $top + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Filter can be used to restrict the results to campaigns matching + a specific state. The syntax is `$filter=state eq 'draft'`. + Valid state values are: draft, scheduled, in-progress, and + finished. Only the eq operator and the state property are + supported. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Sort results by an expression which looks like `$orderby=id asc` + (this example is actually the default behavior). The syntax is + orderby={property} {direction} or just orderby={property}. The + available sorting properties are id, name, state, activatedDate, + and finishedDate. The available directions are asc (for + ascending order) and desc (for descending order). When not + specified the asc direction is used. Only one property at a time + can be used for sorting. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $orderby + serializedName: $orderby + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Restrict results to campaigns matching the optional `search` + expression. This currently performs the search based on the name + on the campaign only, case insensitive. If the campaign contains + the value of the `search` parameter anywhere in the name, it + matches. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $search + serializedName: $search + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_50 + isNullable: true + returnType: + body: *ref_50 + isNullable: true + serializedName: Campaigns_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind} + - defaultResponse: + body: *ref_1 + headers: *ref_51 + isNullable: true + deprecated: false + description: 'Create a push campaign (announcement, poll, data push or native push).' + extensions: + x-ms-requestBody-index: '6' + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Create + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters supplied to the Update Campaign operation. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_22 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_27 + headers: *ref_51 + isNullable: true + returnType: + body: *ref_27 + headers: *ref_51 + isNullable: true + serializedName: Campaigns_Create + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind} + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + The Get campaign operation retrieves information about a previously + created campaign. + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_53 + isNullable: true + returnType: + body: *ref_53 + isNullable: true + serializedName: Campaigns_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id} + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Update an existing push campaign (announcement, poll, data push or + native push). + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: Update + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters supplied to the Update Campaign operation. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_22 + name: + fixed: false + raw: parameters + serializedName: parameters + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: Campaigns_Update + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id} + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Delete a campaign previously created by a call to Create campaign. + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: Campaigns_Delete + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id} + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + The Get campaign operation retrieves information about a previously + created campaign. + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetByName + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_53 + isNullable: true + returnType: + body: *ref_53 + isNullable: true + serializedName: Campaigns_GetByName + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaignsByName/{kind}/{name} + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Test an existing campaign (created with Create campaign) on a set of + devices. + extensions: + x-ms-requestBody-index: '7' + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: TestSaved + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters supplied to the Test Campaign operation. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_21 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: Campaigns_TestSaved + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/test + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Test a new campaign on a set of devices. + extensions: + x-ms-requestBody-index: '6' + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: TestNew + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters supplied to the Test Campaign operation. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_54 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_24 + isNullable: true + returnType: + body: *ref_24 + isNullable: true + serializedName: Campaigns_TestNew + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/test + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Activate a campaign previously created by a call to Create campaign. + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Activate + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: Campaigns_Activate + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/activate + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Suspend a push campaign previously activated by a call to Activate + campaign. + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Suspend + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: Campaigns_Suspend + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/suspend + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Push a previously saved campaign (created with Create campaign) to a + set of devices. + extensions: + x-ms-requestBody-index: '7' + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Push + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters supplied to the Push Campaign operation. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_55 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_56 + isNullable: true + returnType: + body: *ref_56 + isNullable: true + serializedName: Campaigns_Push + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/push + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Get all the campaign statistics. + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetStatistics + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_57 + isNullable: true + returnType: + body: *ref_57 + isNullable: true + serializedName: Campaigns_GetStatistics + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/statistics + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Finish a push campaign previously activated by a call to Activate + campaign. + group: + fixed: false + raw: Campaigns + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Finish + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign kind. + extensions: + x-ms-enum: + modelAsString: true + name: CampaignKinds + isConstant: false + isRequired: true + location: path + modelType: *ref_49 + name: + fixed: false + raw: kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Campaign identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: Campaigns_Finish + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/finish + name: + fixed: false + raw: Campaigns + nameForProperty: Campaigns + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Query the information associated to the devices running an + application. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: Devices + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Number of devices to return with each call. Defaults to 100 and + cannot return more. Passing a greater value is ignored. The + response contains a `nextLink` property describing the URI path + to get the next page of results if not all results could be + returned at once. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $top + serializedName: $top + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + By default all `meta` and `appInfo` properties are returned, + this property is used to restrict the output to the desired + properties. It also excludes all devices from the output that + have none of the selected properties. In other terms, only + devices having at least one of the selected property being set + is part of the results. Examples: - `$select=appInfo` : select + all devices having at least 1 appInfo, return them all and don’t + return any meta property. - `$select=meta` : return only meta + properties in the output. - + `$select=appInfo,meta/firstSeen,meta/lastSeen` : return all + `appInfo`, plus meta object containing only firstSeen and + lastSeen properties. The format is thus a comma separated list + of properties to select. Use `appInfo` to select all appInfo + properties, `meta` to select all meta properties. Use + `appInfo/{key}` and `meta/{key}` to select specific appInfo and + meta properties. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $select + serializedName: $select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Filter can be used to reduce the number of results. Filter is a + boolean expression that can look like the following examples: * + `$filter=deviceId gt 'abcdef0123456789abcdef0123456789'` * + `$filter=lastModified le 1447284263690L` * `$filter=(deviceId ge + 'abcdef0123456789abcdef0123456789') and (deviceId lt + 'bacdef0123456789abcdef0123456789') and (lastModified gt + 1447284263690L)` The first example is used automatically for + paging when returning the `nextLink` property. The filter + expression is a combination of checks on some properties that + can be compared to their value. The available operators are: * + `gt` : greater than * `ge` : greater than or equals * `lt` : + less than * `le` : less than or equals * `and` : to add + multiple checks (all checks must pass), optional parentheses can + be used. The properties that can be used in the expression are + the following: * `deviceId {operator} '{deviceIdValue}'` : a + lexicographical comparison is made on the deviceId value, use + single quotes for the value. * `lastModified {operator} + {number}L` : returns only meta properties or appInfo properties + whose last value modification timestamp compared to the + specified value is matching (value is milliseconds since January + 1st, 1970 UTC). Please note the `L` character after the number + of milliseconds, its required when the number of milliseconds + exceeds `2^31 - 1` (which is always the case for recent + timestamps). Using `lastModified` excludes all devices from the + output that have no property matching the timestamp criteria, + like `$select`. Please note that the internal value of + `lastModified` timestamp for a given property is never part of + the results. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_58 + isNullable: true + returnType: + body: *ref_58 + isNullable: true + serializedName: Devices_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Get the information associated to a device running an application. + group: + fixed: false + raw: Devices + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetByDeviceId + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Device identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: deviceId + serializedName: deviceId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_59 + isNullable: true + returnType: + body: *ref_59 + isNullable: true + serializedName: Devices_GetByDeviceId + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/{deviceId} + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + Get the information associated to a device running an application + using the user identifier. + group: + fixed: false + raw: Devices + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetByUserId + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: User identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: userId + serializedName: userId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_59 + isNullable: true + returnType: + body: *ref_59 + isNullable: true + serializedName: Devices_GetByUserId + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/users/{userId} + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: > + Update the tags registered for a set of devices running an + application. Updates are performed asynchronously, meaning that a few + seconds are needed before the modifications appear in the results of + the Get device command. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: Devices + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: TagByDeviceId + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_60 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_61 + isNullable: true + returnType: + body: *ref_61 + isNullable: true + serializedName: Devices_TagByDeviceId + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/tag + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: > + Update the tags registered for a set of users running an application. + Updates are performed asynchronously, meaning that a few seconds are + needed before the modifications appear in the results of the Get + device command. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: Devices + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: TagByUserId + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_60 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_61 + isNullable: true + returnType: + body: *ref_61 + isNullable: true + serializedName: Devices_TagByUserId + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/users/tag + name: + fixed: false + raw: Devices + nameForProperty: Devices + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Get the list of export tasks. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + constraints: + InclusiveMinimum: '0' + defaultValue: + fixed: false + raw: '0' + documentation: + fixed: false + raw: >- + Control paging of export tasks, start results at the given + offset, defaults to 0 (1st page of data). + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $skip + serializedName: $skip + - collectionFormat: none + constraints: + InclusiveMaximum: '40' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '20' + documentation: + fixed: false + raw: >- + Control paging of export tasks, number of export tasks to return + with each call. By default, it returns all export tasks with a + default paging of 20. + + The response contains a `nextLink` property describing the path + to get the next page if there are more results. + + The maximum paging limit for $top is 40. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $top + serializedName: $top + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Sort results by an expression which looks like `$orderby=taskId + asc` (default when not specified). + + The syntax is orderby={property} {direction} or just + orderby={property}. + + Properties that can be specified for sorting: taskId, + errorDetails, dateCreated, taskStatus, and dateCreated. + + The available directions are asc (for ascending order) and desc + (for descending order). + + When not specified the asc direction is used. + + Only one orderby property can be specified. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $orderby + serializedName: $orderby + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_62 + isNullable: true + returnType: + body: *ref_62 + isNullable: true + serializedName: ExportTasks_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Retrieves information about a previously created export task. + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Export task identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_37 + isNullable: true + returnType: + body: *ref_37 + isNullable: true + serializedName: ExportTasks_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/{id} + - defaultResponse: + body: *ref_1 + headers: *ref_63 + isNullable: true + deprecated: false + description: Creates a task to export activities. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateActivitiesTask + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_64 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_63 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_63 + isNullable: true + serializedName: ExportTasks_CreateActivitiesTask + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/activities + - defaultResponse: + body: *ref_1 + headers: *ref_65 + isNullable: true + deprecated: false + description: Creates a task to export crashes. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateCrashesTask + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_64 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_65 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_65 + isNullable: true + serializedName: ExportTasks_CreateCrashesTask + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/crashes + - defaultResponse: + body: *ref_1 + headers: *ref_66 + isNullable: true + deprecated: false + description: Creates a task to export errors. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateErrorsTask + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_64 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_66 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_66 + isNullable: true + serializedName: ExportTasks_CreateErrorsTask + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/errors + - defaultResponse: + body: *ref_1 + headers: *ref_67 + isNullable: true + deprecated: false + description: Creates a task to export events. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateEventsTask + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_64 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_67 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_67 + isNullable: true + serializedName: ExportTasks_CreateEventsTask + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/events + - defaultResponse: + body: *ref_1 + headers: *ref_68 + isNullable: true + deprecated: false + description: Creates a task to export jobs. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateJobsTask + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_64 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_68 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_68 + isNullable: true + serializedName: ExportTasks_CreateJobsTask + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/jobs + - defaultResponse: + body: *ref_1 + headers: *ref_69 + isNullable: true + deprecated: false + description: Creates a task to export sessions. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateSessionsTask + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_64 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_69 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_69 + isNullable: true + serializedName: ExportTasks_CreateSessionsTask + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/sessions + - defaultResponse: + body: *ref_1 + headers: *ref_70 + isNullable: true + deprecated: false + description: Creates a task to export tags. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateTagsTask + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_71 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_70 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_70 + isNullable: true + serializedName: ExportTasks_CreateTagsTask + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/tags + - defaultResponse: + body: *ref_1 + headers: *ref_72 + isNullable: true + deprecated: false + description: Creates a task to export tags. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateTokensTask + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_71 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_72 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_72 + isNullable: true + serializedName: ExportTasks_CreateTokensTask + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/tokens + - defaultResponse: + body: *ref_1 + headers: *ref_73 + isNullable: true + deprecated: false + description: Creates a task to export push campaign data for a date range. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateFeedbackTaskByDateRange + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_74 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_73 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_73 + isNullable: true + serializedName: ExportTasks_CreateFeedbackTaskByDateRange + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/feedbackByDate + - defaultResponse: + body: *ref_1 + headers: *ref_75 + isNullable: true + deprecated: false + description: Creates a task to export push campaign data for a set of campaigns. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ExportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CreateFeedbackTaskByCampaign + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_76 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_37 + headers: *ref_75 + isNullable: true + returnType: + body: *ref_37 + headers: *ref_75 + isNullable: true + serializedName: ExportTasks_CreateFeedbackTaskByCampaign + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/feedbackByCampaign + name: + fixed: false + raw: ExportTasks + nameForProperty: ExportTasks + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: Get the list of import jobs. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: ImportTasks + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + constraints: + InclusiveMinimum: '0' + defaultValue: + fixed: false + raw: '0' + documentation: + fixed: false + raw: >- + Control paging of import jobs, start results at the given + offset, defaults to 0 (1st page of data). + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $skip + serializedName: $skip + - collectionFormat: none + constraints: + InclusiveMaximum: '40' + InclusiveMinimum: '1' + defaultValue: + fixed: false + raw: '20' + documentation: + fixed: false + raw: >- + Control paging of import jobs, number of import jobs to return + with each call. By default, it returns all import jobs with a + default paging of 20. + + The response contains a `nextLink` property describing the path + to get the next page if there are more results. + + The maximum paging limit for $top is 40. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: $top + serializedName: $top + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Sort results by an expression which looks like `$orderby=jobId + asc` (default when not specified). + + The syntax is orderby={property} {direction} or just + orderby={property}. + + Properties that can be specified for sorting: jobId, + errorDetails, dateCreated, jobStatus, and dateCreated. + + The available directions are asc (for ascending order) and desc + (for descending order). + + When not specified the asc direction is used. + + Only one orderby property can be specified. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $orderby + serializedName: $orderby + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_77 + isNullable: true + returnType: + body: *ref_77 + isNullable: true + serializedName: ImportTasks_List + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/importTasks + - defaultResponse: + body: *ref_1 + headers: *ref_78 + isNullable: true + deprecated: false + description: Creates a job to import the specified data to a storageUrl. + extensions: + x-ms-requestBody-index: '5' + group: + fixed: false + raw: ImportTasks + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Create + parameters: + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_38 + name: + fixed: false + raw: parameters + serializedName: parameters + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_40 + headers: *ref_78 + isNullable: true + Created: + body: *ref_40 + headers: *ref_78 + isNullable: true + returnType: + body: *ref_40 + headers: *ref_78 + isNullable: true + serializedName: ImportTasks_Create + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/importTasks + - defaultResponse: + body: *ref_1 + isNullable: true + deprecated: false + description: >- + The Get import job operation retrieves information about a previously + created import job. + group: + fixed: false + raw: ImportTasks + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Import job identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_42 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_47 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_48 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application collection. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCollection + serializedName: appCollection + - clientProperty: *ref_52 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application resource name. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appName + serializedName: appName + - clientProperty: *ref_43 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_40 + isNullable: true + returnType: + body: *ref_40 + isNullable: true + serializedName: ImportTasks_Get + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/importTasks/{id} + name: + fixed: false + raw: ImportTasks + nameForProperty: ImportTasks + typeName: + fixed: false +properties: + - *ref_42 + - *ref_43 + - *ref_47 + - *ref_48 + - *ref_52 diff --git a/test/Expected/specs-network/code-model-v1-yaml.yaml b/test/Expected/specs-network/code-model-v1-yaml.yaml new file mode 100644 index 0000000..d572c1d --- /dev/null +++ b/test/Expected/specs-network/code-model-v1-yaml.yaml @@ -0,0 +1,496 @@ +--- +apiVersion: '2017-10-01' +baseUrl: 'https://management.azure.com' +documentation: >- + The Microsoft Azure Network management API provides a RESTful set of web + services that interact with Microsoft Azure Networks service to manage your + network resources. The API has entities that capture the relationship between + an end user and the Microsoft Azure Networks service. +enumTypes: + - &ref_1 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: NetworkOperationStatus + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: InProgress + serializedName: InProgress + - name: Succeeded + serializedName: Succeeded + - name: Failed + serializedName: Failed +extensions: + security: + - azure_auth: + - user_impersonation +modelTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: ErrorDetails + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: target + realPath: + - target + serializedName: target + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: ErrorDetails + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: target + realPath: + - target + serializedName: target + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_0 + name: + fixed: false + name: + fixed: false + raw: details + realPath: + - details + serializedName: details + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: innerError + realPath: + - innerError + serializedName: innerError + serializedName: Error + - $type: CompositeType + containsConstantProperties: false + documentation: >- + The response body contains the status of the specified asynchronous + operation, indicating whether it has succeeded, is in progress, or has + failed. Note that this status is distinct from the HTTP status code + returned for the Get Operation Status operation itself. If the + asynchronous operation succeeded, the response body includes the HTTP + status code for the successful request. If the asynchronous operation + failed, the response body includes the HTTP status code for the failed + request and error information regarding the failure. + name: + fixed: false + raw: AzureAsyncOperationResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Status of the Azure async operation. Possible values are: + 'InProgress', 'Succeeded', and 'Failed'. + extensions: + x-ms-enum: + modelAsString: true + name: NetworkOperationStatus + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + serializedName: AzureAsyncOperationResult + - $type: CompositeType + containsConstantProperties: false + documentation: Common resource representation. + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: Resource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource ID. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource name. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource type. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource location. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource tags. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + serializedName: Resource + - $type: CompositeType + containsConstantProperties: false + documentation: Reference to another subresource. + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: SubResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource ID. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: SubResource + - $type: CompositeType + containsConstantProperties: false + documentation: Tags object for patch operations. + name: + fixed: false + raw: TagsObject + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource tags. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + serializedName: TagsObject +modelsName: Models +name: NetworkManagementClient +namespace: '' +properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The subscription credentials which uniquely identify the Microsoft Azure + subscription. The subscription ID forms part of the URI for every + service call. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client API version. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version diff --git a/test/Expected/specs-search/code-model-v1-yaml.yaml b/test/Expected/specs-search/code-model-v1-yaml.yaml new file mode 100644 index 0000000..d949fbd --- /dev/null +++ b/test/Expected/specs-search/code-model-v1-yaml.yaml @@ -0,0 +1,1029 @@ +--- +apiVersion: '2016-09-01' +baseUrl: '' +codeGenExtensions: + syncMethods: None + useDateTimeOffset: true +documentation: >- + Client that can be used to query an Azure Search index and upload, merge, or + delete documents. +enumTypes: + - $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: IndexActionType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: upload + serializedName: upload + - name: merge + serializedName: merge + - name: mergeOrUpload + serializedName: mergeOrUpload + - name: delete + serializedName: delete + - &ref_2 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: SearchMode + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: any + serializedName: any + - name: all + serializedName: all + - &ref_1 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: QueryType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: simple + serializedName: simple + - name: full + serializedName: full +modelTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + documentation: Status of an indexing operation for a single document. + extensions: + x-ms-external: true + name: + fixed: false + raw: IndexingResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The key of a document that was in the indexing request. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: key + realPath: + - key + serializedName: key + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The error message explaining why the indexing operation failed for + the document identified by the key; null if indexing succeeded. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: errorMessage + realPath: + - errorMessage + serializedName: errorMessage + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A value indicating whether the indexing operation succeeded for the + document identified by the key. + extensions: + x-ms-client-name: Succeeded + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: statusCode + realPath: + - statusCode + serializedName: statusCode + serializedName: IndexingResult + - $type: CompositeType + containsConstantProperties: false + documentation: >- + Response containing the status of operations for all documents in the + indexing request. + name: + fixed: false + raw: DocumentIndexResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The list of status information for each document in the indexing + request. + extensions: + x-ms-client-name: Results + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_0 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: DocumentIndexResult + - $type: CompositeType + containsConstantProperties: false + documentation: >- + Parameters for filtering, sorting, faceting, paging, and other search + query behaviors. + name: + fixed: false + raw: SearchParametersPayload + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A value that specifies whether to fetch the total count of results. + Default is false. Setting this value to true may have a performance + impact. Note that the count returned is an approximation. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: count + realPath: + - count + serializedName: count + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The list of facet expressions to apply to the search query. Each + facet expression contains a field name, optionally followed by a + comma-separated list of name:value pairs. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: facets + realPath: + - facets + serializedName: facets + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData $filter expression to apply to the search query. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filter + realPath: + - filter + serializedName: filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The comma-separated list of field names to use for hit highlights. + Only searchable fields can be used for hit highlighting. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: highlight + realPath: + - highlight + serializedName: highlight + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A string tag that is appended to hit highlights. Must be set with + HighlightPreTag. Default is </em>. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: highlightPostTag + realPath: + - highlightPostTag + serializedName: highlightPostTag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A string tag that is prepended to hit highlights. Must be set with + HighlightPostTag. Default is <em>. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: highlightPreTag + realPath: + - highlightPreTag + serializedName: highlightPreTag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: minimumCoverage + realPath: + - minimumCoverage + serializedName: minimumCoverage + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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 the geo.distance() function. 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. + extensions: + x-ms-client-name: OrderBy + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: orderby + realPath: + - orderby + serializedName: orderby + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets or sets a value that specifies the syntax of the search query. + The default is 'simple'. Use 'full' if your query uses the Lucene + query syntax. + extensions: + x-ms-enum: + name: QueryType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: queryType + realPath: + - queryType + serializedName: queryType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The list of parameter values to be used in scoring functions (for + example, referencePointParameter) using the format name:value. 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). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: scoringParameters + realPath: + - scoringParameters + serializedName: scoringParameters + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of a scoring profile to evaluate match scores for matching + documents in order to sort the results. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scoringProfile + realPath: + - scoringProfile + serializedName: scoringProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A full-text search query expression; Use null or "*" to match all + documents. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: search + realPath: + - search + serializedName: search + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The comma-separated list of field names to include in the full-text + search. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: searchFields + realPath: + - searchFields + serializedName: searchFields + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A value that specifies whether any or all of the search terms must + be matched in order to count the document as a match. + extensions: + x-ms-enum: + name: SearchMode + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: searchMode + realPath: + - searchMode + serializedName: searchMode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The comma-separated list of fields to retrieve. If unspecified, all + fields marked as retrievable in the schema are included. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: select + realPath: + - select + serializedName: select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: skip + realPath: + - skip + serializedName: skip + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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 passed to + ContinueSearch to retrieve the next page of results. See + DocumentSearchResponse.ContinuationToken for more information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: top + realPath: + - top + serializedName: top + serializedName: SearchParametersPayload + - $type: CompositeType + containsConstantProperties: false + documentation: >- + Parameters for filtering, sorting, fuzzy matching, and other suggestions + query behaviors. + name: + fixed: false + raw: SuggestParametersPayload + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The OData $filter expression to apply to the suggestions query. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filter + realPath: + - filter + serializedName: filter + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A value indicating whether to use fuzzy matching for the suggestion + query. Default is false. when set to true, the query will find + suggestions 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 suggestion + searches are slower and consume more resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: fuzzy + realPath: + - fuzzy + serializedName: fuzzy + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A string tag that is appended to hit highlights. Must be set with + HighlightPreTag. If omitted, hit highlighting of suggestions is + disabled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: highlightPostTag + realPath: + - highlightPostTag + serializedName: highlightPostTag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A string tag that is prepended to hit highlights. Must be set with + HighlightPostTag. If omitted, hit highlighting of suggestions is + disabled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: highlightPreTag + realPath: + - highlightPreTag + serializedName: highlightPreTag + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: minimumCoverage + realPath: + - minimumCoverage + serializedName: minimumCoverage + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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 the geo.distance() function. 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. + extensions: + x-ms-client-name: OrderBy + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: orderby + realPath: + - orderby + serializedName: orderby + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The search text on which to base suggestions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: search + realPath: + - search + serializedName: search + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The comma-separated list of field names to consider when querying + for suggestions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: searchFields + realPath: + - searchFields + serializedName: searchFields + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The comma-separated list of fields to retrieve. If unspecified, all + fields marked as retrievable in the schema are included. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: select + realPath: + - select + serializedName: select + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the suggester as specified in the suggesters collection + that's part of the index definition. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: suggesterName + realPath: + - suggesterName + serializedName: suggesterName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The number of suggestions to retrieve. This must be a value between + 1 and 100. The default is to 5. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: top + realPath: + - top + serializedName: top + serializedName: SuggestParametersPayload +modelsName: Models +name: SearchIndexClient +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Queries the number of documents in the Azure Search index. + extensions: + x-ms-request-id: request-id + externalDocsUrl: 'https://docs.microsoft.com/rest/api/searchservice/Count-Documents' + group: + fixed: false + raw: DocumentsProxy + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Count + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The tracking ID sent with the request to help with debugging. + extensions: + x-ms-client-request-id: true + x-ms-parameter-grouping: + name: search-request-options + isConstant: false + isRequired: false + location: header + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: client-request-id + serializedName: client-request-id + - clientProperty: &ref_4 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_3 + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + isNullable: true + returnType: + body: *ref_3 + isNullable: true + serializedName: DocumentsProxy_Count + url: /docs/$count + name: + fixed: false + raw: DocumentsProxy + nameForProperty: DocumentsProxy + typeName: + fixed: false +properties: + - *ref_4 diff --git a/test/Expected/specs-web/code-model-v1-yaml.yaml b/test/Expected/specs-web/code-model-v1-yaml.yaml new file mode 100644 index 0000000..9c5697b --- /dev/null +++ b/test/Expected/specs-web/code-model-v1-yaml.yaml @@ -0,0 +1,65136 @@ +--- +apiVersion: '2016-08-01' +baseUrl: 'https://management.azure.com' +enumTypes: + - &ref_0 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: LogLevel + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: 'Off' + serializedName: 'Off' + - name: Verbose + serializedName: Verbose + - name: Information + serializedName: Information + - name: Warning + serializedName: Warning + - name: Error + serializedName: Error + - &ref_5 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: BackupItemStatus + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: InProgress + serializedName: InProgress + - name: Failed + serializedName: Failed + - name: Succeeded + serializedName: Succeeded + - name: TimedOut + serializedName: TimedOut + - name: Created + serializedName: Created + - name: Skipped + serializedName: Skipped + - name: PartiallySucceeded + serializedName: PartiallySucceeded + - name: DeleteInProgress + serializedName: DeleteInProgress + - name: DeleteFailed + serializedName: DeleteFailed + - name: Deleted + serializedName: Deleted + - &ref_4 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: DatabaseType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: SqlAzure + serializedName: SqlAzure + - name: MySql + serializedName: MySql + - name: LocalMySql + serializedName: LocalMySql + - name: PostgreSql + serializedName: PostgreSql + - &ref_9 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: FrequencyUnit + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Day + serializedName: Day + - name: Hour + serializedName: Hour + - &ref_11 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: BackupRestoreOperationType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Default + serializedName: Default + - name: Clone + serializedName: Clone + - name: Relocation + serializedName: Relocation + - name: Snapshot + serializedName: Snapshot + - &ref_14 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ConnectionStringType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: MySql + serializedName: MySql + - name: SQLServer + serializedName: SQLServer + - name: SQLAzure + serializedName: SQLAzure + - name: Custom + serializedName: Custom + - name: NotificationHub + serializedName: NotificationHub + - name: ServiceBus + serializedName: ServiceBus + - name: EventHub + serializedName: EventHub + - name: ApiHub + serializedName: ApiHub + - name: DocDb + serializedName: DocDb + - name: RedisCache + serializedName: RedisCache + - name: PostgreSQL + serializedName: PostgreSQL + - &ref_16 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ContinuousWebJobStatus + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Initializing + serializedName: Initializing + - name: Starting + serializedName: Starting + - name: Running + serializedName: Running + - name: PendingRestart + serializedName: PendingRestart + - name: Stopped + serializedName: Stopped + - &ref_17 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: WebJobType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Continuous + serializedName: Continuous + - name: Triggered + serializedName: Triggered + - &ref_20 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: PublishingProfileFormat + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: FileZilla3 + serializedName: FileZilla3 + - name: WebDeploy + serializedName: WebDeploy + - name: Ftp + serializedName: Ftp + - &ref_22 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: DnsVerificationTestResult + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Passed + serializedName: Passed + - name: Failed + serializedName: Failed + - name: Skipped + serializedName: Skipped + - &ref_29 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: AzureResourceType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Website + serializedName: Website + - name: TrafficManager + serializedName: TrafficManager + - &ref_30 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: CustomHostNameDnsRecordType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: CName + serializedName: CName + - name: A + serializedName: A + - &ref_31 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: HostNameType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Verified + serializedName: Verified + - name: Managed + serializedName: Managed + - &ref_32 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: SslState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Disabled + serializedName: Disabled + - name: SniEnabled + serializedName: SniEnabled + - name: IpBasedEnabled + serializedName: IpBasedEnabled + - &ref_40 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: MSDeployLogEntryType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Message + serializedName: Message + - name: Warning + serializedName: Warning + - name: Error + serializedName: Error + - &ref_43 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: MSDeployProvisioningState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: accepted + serializedName: accepted + - name: running + serializedName: running + - name: succeeded + serializedName: succeeded + - name: failed + serializedName: failed + - name: canceled + serializedName: canceled + - &ref_45 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: MySqlMigrationType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: LocalToRemote + serializedName: LocalToRemote + - name: RemoteToLocal + serializedName: RemoteToLocal + - &ref_47 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: OperationStatus + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: InProgress + serializedName: InProgress + - name: Failed + serializedName: Failed + - name: Succeeded + serializedName: Succeeded + - name: TimedOut + serializedName: TimedOut + - name: Created + serializedName: Created + - &ref_49 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: RouteType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: DEFAULT + serializedName: DEFAULT + - name: INHERITED + serializedName: INHERITED + - name: STATIC + serializedName: STATIC + - &ref_69 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: PublicCertificateLocation + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: CurrentUserMy + serializedName: CurrentUserMy + - name: LocalMachineMy + serializedName: LocalMachineMy + - name: Unknown + serializedName: Unknown + - &ref_74 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: UnauthenticatedClientAction + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: RedirectToLoginPage + serializedName: RedirectToLoginPage + - name: AllowAnonymous + serializedName: AllowAnonymous + - &ref_75 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: BuiltInAuthenticationProvider + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: AzureActiveDirectory + serializedName: AzureActiveDirectory + - name: Facebook + serializedName: Facebook + - name: Google + serializedName: Google + - name: MicrosoftAccount + serializedName: MicrosoftAccount + - name: Twitter + serializedName: Twitter + - &ref_77 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: CloneAbilityResult + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Cloneable + serializedName: Cloneable + - name: PartiallyCloneable + serializedName: PartiallyCloneable + - name: NotCloneable + serializedName: NotCloneable + - &ref_93 + $type: EnumType + modelAsExtensible: false + modelAsString: true + name: + fixed: false + raw: ScmType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: None + serializedName: None + - name: Dropbox + serializedName: Dropbox + - name: Tfs + serializedName: Tfs + - name: LocalGit + serializedName: LocalGit + - name: GitHub + serializedName: GitHub + - name: CodePlexGit + serializedName: CodePlexGit + - name: CodePlexHg + serializedName: CodePlexHg + - name: BitbucketGit + serializedName: BitbucketGit + - name: BitbucketHg + serializedName: BitbucketHg + - name: ExternalGit + serializedName: ExternalGit + - name: ExternalHg + serializedName: ExternalHg + - name: OneDrive + serializedName: OneDrive + - name: VSO + serializedName: VSO + - &ref_94 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ManagedPipelineMode + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Integrated + serializedName: Integrated + - name: Classic + serializedName: Classic + - &ref_96 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: SiteLoadBalancing + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: WeightedRoundRobin + serializedName: WeightedRoundRobin + - name: LeastRequests + serializedName: LeastRequests + - name: LeastResponseTime + serializedName: LeastResponseTime + - name: WeightedTotalTraffic + serializedName: WeightedTotalTraffic + - name: RequestHash + serializedName: RequestHash + - &ref_84 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: AutoHealActionType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Recycle + serializedName: Recycle + - name: LogEvent + serializedName: LogEvent + - name: CustomAction + serializedName: CustomAction + - &ref_108 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: SiteExtensionType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Gallery + serializedName: Gallery + - name: WebRoot + serializedName: WebRoot + - &ref_119 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: UsageState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Normal + serializedName: Normal + - name: Exceeded + serializedName: Exceeded + - &ref_120 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: SiteAvailabilityState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Normal + serializedName: Normal + - name: Limited + serializedName: Limited + - name: DisasterRecoveryMode + serializedName: DisasterRecoveryMode + - &ref_116 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: HostType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Standard + serializedName: Standard + - name: Repository + serializedName: Repository + - &ref_136 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: TriggeredWebJobStatus + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Success + serializedName: Success + - name: Failed + serializedName: Failed + - name: Error + serializedName: Error + - &ref_157 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: StatusOptions + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Ready + serializedName: Ready + - name: Pending + serializedName: Pending + - name: Creating + serializedName: Creating + - &ref_158 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ProvisioningState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Succeeded + serializedName: Succeeded + - name: Failed + serializedName: Failed + - name: Canceled + serializedName: Canceled + - name: InProgress + serializedName: InProgress + - name: Deleting + serializedName: Deleting +extensions: + security: + - azure_auth: + - user_impersonation +modelTypes: + - &ref_1 + $type: CompositeType + containsConstantProperties: false + documentation: Application logs to file system configuration. + name: + fixed: false + raw: FileSystemApplicationLogsConfig + properties: + - collectionFormat: none + defaultValue: + fixed: false + raw: 'Off' + documentation: + fixed: false + raw: Log level. + extensions: + x-ms-enum: + modelAsString: false + name: LogLevel + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: level + realPath: + - level + serializedName: level + serializedName: FileSystemApplicationLogsConfig + - &ref_2 + $type: CompositeType + containsConstantProperties: false + documentation: Application logs to Azure table storage configuration. + name: + fixed: false + raw: AzureTableStorageApplicationLogsConfig + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Log level. + extensions: + x-ms-enum: + modelAsString: false + name: LogLevel + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: level + realPath: + - level + serializedName: level + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SAS URL to an Azure table with add/query/delete permissions. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sasUrl + realPath: + - sasUrl + serializedName: sasUrl + serializedName: AzureTableStorageApplicationLogsConfig + - &ref_3 + $type: CompositeType + containsConstantProperties: false + documentation: Application logs azure blob storage configuration. + name: + fixed: false + raw: AzureBlobStorageApplicationLogsConfig + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Log level. + extensions: + x-ms-enum: + modelAsString: false + name: LogLevel + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: level + realPath: + - level + serializedName: level + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + SAS url to a azure blob container with read/write/list/delete + permissions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sasUrl + realPath: + - sasUrl + serializedName: sasUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Retention in days. + Remove blobs older than X days. + 0 or lower means no retention. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: retentionInDays + realPath: + - retentionInDays + serializedName: retentionInDays + serializedName: AzureBlobStorageApplicationLogsConfig + - &ref_112 + $type: CompositeType + containsConstantProperties: false + documentation: Application logs configuration. + name: + fixed: false + raw: ApplicationLogsConfig + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application logs to file system configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: fileSystem + realPath: + - fileSystem + serializedName: fileSystem + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application logs to azure table storage configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: azureTableStorage + realPath: + - azureTableStorage + serializedName: azureTableStorage + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application logs to blob storage configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: azureBlobStorage + realPath: + - azureBlobStorage + serializedName: azureBlobStorage + serializedName: ApplicationLogsConfig + - &ref_36 + $type: CompositeType + containsConstantProperties: false + documentation: Http logs to azure blob storage configuration. + name: + fixed: false + raw: AzureBlobStorageHttpLogsConfig + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + SAS url to a azure blob container with read/write/list/delete + permissions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sasUrl + realPath: + - sasUrl + serializedName: sasUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Retention in days. + Remove blobs older than X days. + 0 or lower means no retention. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: retentionInDays + realPath: + - retentionInDays + serializedName: retentionInDays + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + True if configuration is enabled, false if it is disabled and null + if configuration is not set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enabled + realPath: + - enabled + serializedName: enabled + serializedName: AzureBlobStorageHttpLogsConfig + - &ref_6 + $type: CompositeType + containsConstantProperties: false + documentation: Database backup settings. + name: + fixed: false + raw: DatabaseBackupSetting + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Database type (e.g. SqlAzure / MySql). + extensions: + x-ms-enum: + modelAsString: true + name: DatabaseType + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_4 + name: + fixed: false + raw: databaseType + realPath: + - databaseType + serializedName: databaseType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Contains a connection string name that is linked to the + SiteConfig.ConnectionStrings. + + This is used during restore with overwrite connection strings + options. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: connectionStringName + realPath: + - connectionStringName + serializedName: connectionStringName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Contains a connection string to a database which is being backed up + or restored. If the restore should happen to a new database, the + database name inside is the new one. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: connectionString + realPath: + - connectionString + serializedName: connectionString + serializedName: DatabaseBackupSetting + - &ref_7 + $type: CompositeType + containsConstantProperties: false + documentation: BackupItem resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: BackupItem_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Id of the backup. + extensions: + x-ms-client-name: BackupId + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + SAS URL for the storage account container which contains this + backup. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: storageAccountUrl + realPath: + - storageAccountUrl + serializedName: storageAccountUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the blob which contains data for this backup. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: blobName + realPath: + - blobName + serializedName: blobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of this backup. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Backup status. + extensions: + x-ms-enum: + modelAsString: false + name: BackupItemStatus + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_5 + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Size of the backup in bytes. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: sizeInBytes + realPath: + - sizeInBytes + serializedName: sizeInBytes + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Timestamp of the backup creation. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: created + realPath: + - created + serializedName: created + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details regarding this backup. Might contain an error message. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: log + realPath: + - log + serializedName: log + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of databases included in the backup. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_6 + name: + fixed: false + name: + fixed: false + raw: databases + realPath: + - databases + serializedName: databases + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + True if this backup has been created due to a schedule being + triggered. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: scheduled + realPath: + - scheduled + serializedName: scheduled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Timestamp of a last restore operation which used this backup. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastRestoreTimeStamp + realPath: + - lastRestoreTimeStamp + serializedName: lastRestoreTimeStamp + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Timestamp when this backup finished. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: finishedTimeStamp + realPath: + - finishedTimeStamp + serializedName: finishedTimeStamp + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unique correlation identifier. Please use this along with the + timestamp while communicating with Azure support. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: correlationId + realPath: + - correlationId + serializedName: correlationId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Size of the original web app which has been backed up. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: websiteSizeInBytes + realPath: + - websiteSizeInBytes + serializedName: websiteSizeInBytes + serializedName: BackupItem_properties + - &ref_8 + $type: CompositeType + baseModelType: &ref_12 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Azure proxy only resource. This resource is not tracked by Azure + Resource Manager. + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: ProxyOnlyResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Name. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Kind of resource. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: kind + realPath: + - kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource type. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + serializedName: ProxyOnlyResource + containsConstantProperties: false + documentation: Backup description. + name: + fixed: false + raw: BackupItem + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: BackupItem resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_7 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: BackupItem + - &ref_176 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of backup items. + name: + fixed: false + raw: BackupItemCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_8 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: BackupItemCollection + - &ref_10 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Description of a backup schedule. Describes how often should be the backup + performed and what should be the retention policy. + name: + fixed: false + raw: BackupSchedule + properties: + - collectionFormat: none + defaultValue: + fixed: false + raw: '7' + documentation: + fixed: false + raw: >- + How often the backup should be executed (e.g. for weekly backup, + this should be set to 7 and FrequencyUnit should be set to Day) + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: frequencyInterval + realPath: + - frequencyInterval + serializedName: frequencyInterval + - collectionFormat: none + defaultValue: + fixed: false + raw: Day + documentation: + fixed: false + raw: >- + The unit of time for how often the backup should be executed (e.g. + for weekly backup, this should be set to Day and FrequencyInterval + should be set to 7) + extensions: + x-ms-enum: + modelAsString: false + name: FrequencyUnit + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_9 + name: + fixed: false + raw: frequencyUnit + realPath: + - frequencyUnit + serializedName: frequencyUnit + - collectionFormat: none + defaultValue: + fixed: false + raw: 'true' + documentation: + fixed: false + raw: >- + True if the retention policy should always keep at least one backup + in the storage account, regardless how old it is; false otherwise. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: keepAtLeastOneBackup + realPath: + - keepAtLeastOneBackup + serializedName: keepAtLeastOneBackup + - collectionFormat: none + defaultValue: + fixed: false + raw: '30' + documentation: + fixed: false + raw: After how many days backups should be deleted. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: retentionPeriodInDays + realPath: + - retentionPeriodInDays + serializedName: retentionPeriodInDays + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: When the schedule should start working. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Last time when this schedule was triggered. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastExecutionTime + realPath: + - lastExecutionTime + serializedName: lastExecutionTime + serializedName: BackupSchedule + - &ref_13 + $type: CompositeType + containsConstantProperties: false + documentation: BackupRequest resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: BackupRequest_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the backup. + extensions: + x-ms-client-name: BackupRequestName + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + True if the backup schedule is enabled (must be included in that + case), false if the backup schedule should be disabled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enabled + realPath: + - enabled + serializedName: enabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SAS URL to the container. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: storageAccountUrl + realPath: + - storageAccountUrl + serializedName: storageAccountUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Schedule for the backup if it is executed periodically. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_10 + name: + fixed: false + raw: backupSchedule + realPath: + - backupSchedule + serializedName: backupSchedule + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Databases included in the backup. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_6 + name: + fixed: false + name: + fixed: false + raw: databases + realPath: + - databases + serializedName: databases + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Type of the backup. + extensions: + x-ms-enum: + modelAsString: false + name: BackupRestoreOperationType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_11 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + serializedName: BackupRequest_properties + - &ref_175 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Description of a backup which will be performed. + name: + fixed: false + raw: BackupRequest + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: BackupRequest resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_13 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: BackupRequest + - &ref_15 + $type: CompositeType + containsConstantProperties: false + documentation: Database connection string value to type pair. + name: + fixed: false + raw: ConnStringValueTypePair + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value of pair. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Type of database. + extensions: + x-ms-enum: + modelAsString: false + name: ConnectionStringType + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_14 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + serializedName: ConnStringValueTypePair + - &ref_182 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: String dictionary resource. + name: + fixed: false + raw: ConnectionStringDictionary + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Connection strings. + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: *ref_15 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: ConnectionStringDictionary + - &ref_18 + $type: CompositeType + containsConstantProperties: false + documentation: ContinuousWebJob resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: ContinuousWebJob_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job status. + extensions: + x-ms-enum: + modelAsString: false + name: ContinuousWebJobStatus + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_16 + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Detailed status. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: detailedStatus + realPath: + - detailedStatus + serializedName: detailedStatus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Log URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: logUrl + realPath: + - logUrl + serializedName: logUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job name. Used as job identifier in ARM resource URI. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Run command. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: runCommand + realPath: + - runCommand + serializedName: runCommand + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Extra Info URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: extraInfoUrl + realPath: + - extraInfoUrl + serializedName: extraInfoUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job type. + extensions: + x-ms-enum: + modelAsString: false + name: WebJobType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_17 + name: + fixed: false + raw: jobType + realPath: + - jobType + serializedName: jobType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Error information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Using SDK? + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: usingSdk + realPath: + - usingSdk + serializedName: usingSdk + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job settings. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: settings + realPath: + - settings + serializedName: settings + serializedName: ContinuousWebJob_properties + - &ref_19 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Continuous Web Job Information. + name: + fixed: false + raw: ContinuousWebJob + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ContinuousWebJob resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_18 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: ContinuousWebJob + - &ref_189 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of Kudu continuous web job information elements. + name: + fixed: false + raw: ContinuousWebJobCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_19 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ContinuousWebJobCollection + - &ref_221 + $type: CompositeType + containsConstantProperties: false + documentation: Publishing options for requested profile. + name: + fixed: false + raw: CsmPublishingProfileOptions + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Name of the format. Valid values are: + FileZilla3 + WebDeploy -- default + Ftp + extensions: + x-ms-enum: + modelAsString: true + name: PublishingProfileFormat + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_20 + name: + fixed: false + raw: format + realPath: + - format + serializedName: format + serializedName: CsmPublishingProfileOptions + - &ref_174 + $type: CompositeType + containsConstantProperties: false + documentation: Deployment slot parameters. + name: + fixed: false + raw: CsmSlotEntity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Destination deployment slot during swap operation. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: targetSlot + realPath: + - targetSlot + serializedName: targetSlot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to preserve Virtual Network to the slot during + swap; otherwise, false. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: preserveVnet + realPath: + - preserveVnet + serializedName: preserveVnet + serializedName: CsmSlotEntity + - &ref_21 + $type: CompositeType + containsConstantProperties: false + documentation: Body of the error response returned from the API. + name: + fixed: false + raw: ErrorEntity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Type of error. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: extendedCode + realPath: + - extendedCode + serializedName: extendedCode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Message template. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: messageTemplate + realPath: + - messageTemplate + serializedName: messageTemplate + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters for the template. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: parameters + realPath: + - parameters + serializedName: parameters + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Inner errors. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_21 + name: + fixed: false + name: + fixed: false + raw: innerErrors + realPath: + - innerErrors + serializedName: innerErrors + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Basic error code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Any details of the error. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: ErrorEntity + - &ref_23 + $type: CompositeType + containsConstantProperties: false + documentation: CustomHostnameAnalysisResult resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: CustomHostnameAnalysisResult_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if hostname is already verified; otherwise, + false. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isHostnameAlreadyVerified + realPath: + - isHostnameAlreadyVerified + serializedName: isHostnameAlreadyVerified + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: DNS verification test result. + extensions: + x-ms-enum: + modelAsString: false + name: DnsVerificationTestResult + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_22 + name: + fixed: false + raw: customDomainVerificationTest + realPath: + - customDomainVerificationTest + serializedName: customDomainVerificationTest + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Raw failure information if DNS verification fails. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_21 + name: + fixed: false + raw: customDomainVerificationFailureInfo + realPath: + - customDomainVerificationFailureInfo + serializedName: customDomainVerificationFailureInfo + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if there is a conflict on a scale unit; otherwise, + false. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: hasConflictOnScaleUnit + realPath: + - hasConflictOnScaleUnit + serializedName: hasConflictOnScaleUnit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if htere is a conflict across subscriptions; + otherwise, false. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: hasConflictAcrossSubscription + realPath: + - hasConflictAcrossSubscription + serializedName: hasConflictAcrossSubscription + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the conflicting app on scale unit if it's within the same + subscription. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: conflictingAppResourceId + realPath: + - conflictingAppResourceId + serializedName: conflictingAppResourceId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: CName records controller can see for this hostname. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: cNameRecords + realPath: + - cNameRecords + serializedName: cNameRecords + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: TXT records controller can see for this hostname. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: txtRecords + realPath: + - txtRecords + serializedName: txtRecords + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A records controller can see for this hostname. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: aRecords + realPath: + - aRecords + serializedName: aRecords + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Alternate CName records controller can see for this hostname. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: alternateCNameRecords + realPath: + - alternateCNameRecords + serializedName: alternateCNameRecords + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Alternate TXT records controller can see for this hostname. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: alternateTxtRecords + realPath: + - alternateTxtRecords + serializedName: alternateTxtRecords + serializedName: CustomHostnameAnalysisResult_properties + - &ref_173 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Custom domain analysis. + name: + fixed: false + raw: CustomHostnameAnalysisResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: CustomHostnameAnalysisResult resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_23 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: CustomHostnameAnalysisResult + - &ref_24 + $type: CompositeType + containsConstantProperties: false + documentation: Deployment resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: Deployment_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Identifier for deployment. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Deployment status. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details about deployment status. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Who authored the deployment. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: author + realPath: + - author + serializedName: author + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Who performed the deployment. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: deployer + realPath: + - deployer + serializedName: deployer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Author email. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: authorEmail + realPath: + - authorEmail + serializedName: authorEmail + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start time. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: End time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + True if deployment is currently active, false if completed and null + if not started. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: active + realPath: + - active + serializedName: active + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details on deployment. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: details + realPath: + - details + serializedName: details + serializedName: Deployment_properties + - &ref_25 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: User crendentials used for publishing activity. + name: + fixed: false + raw: Deployment + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Deployment resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_24 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: Deployment + - &ref_190 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of app deployments. + name: + fixed: false + raw: DeploymentCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_25 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: DeploymentCollection + - &ref_114 + $type: CompositeType + containsConstantProperties: false + documentation: Enabled configuration. + name: + fixed: false + raw: EnabledConfig + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + True if configuration is enabled, false if it is disabled and null + if configuration is not set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enabled + realPath: + - enabled + serializedName: enabled + serializedName: EnabledConfig + - &ref_35 + $type: CompositeType + containsConstantProperties: false + documentation: Http logs to file system configuration. + name: + fixed: false + raw: FileSystemHttpLogsConfig + properties: + - collectionFormat: none + constraints: + InclusiveMaximum: '100' + InclusiveMinimum: '25' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Maximum size in megabytes that http log files can use. + + When reached old log files will be removed to make space for new + ones. + + Value can range between 25 and 100. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: retentionInMb + realPath: + - retentionInMb + serializedName: retentionInMb + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Retention in days. + Remove files older than X days. + 0 or lower means no retention. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: retentionInDays + realPath: + - retentionInDays + serializedName: retentionInDays + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + True if configuration is enabled, false if it is disabled and null + if configuration is not set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enabled + realPath: + - enabled + serializedName: enabled + serializedName: FileSystemHttpLogsConfig + - &ref_26 + $type: CompositeType + containsConstantProperties: false + documentation: FunctionEnvelope resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: FunctionEnvelope_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function name. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function App ID. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: functionAppId + realPath: + - functionAppId + serializedName: functionAppId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Script root path URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scriptRootPathHref + realPath: + - scriptRootPathHref + serializedName: scriptRootPathHref + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Script URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scriptHref + realPath: + - scriptHref + serializedName: scriptHref + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Config URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: configHref + realPath: + - configHref + serializedName: configHref + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Secrets file URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: secretsFileHref + realPath: + - secretsFileHref + serializedName: secretsFileHref + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: href + realPath: + - href + serializedName: href + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Config information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: config + realPath: + - config + serializedName: config + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: File list. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: files + realPath: + - files + serializedName: files + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Test data used when testing via the Azure Portal. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: testData + realPath: + - testData + serializedName: testData + serializedName: FunctionEnvelope_properties + - &ref_27 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Web Job Information. + name: + fixed: false + raw: FunctionEnvelope + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: FunctionEnvelope resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_26 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: FunctionEnvelope + - &ref_195 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of Kudu function information elements. + name: + fixed: false + raw: FunctionEnvelopeCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_27 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: FunctionEnvelopeCollection + - &ref_28 + $type: CompositeType + containsConstantProperties: false + documentation: FunctionSecrets resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: FunctionSecrets_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Secret key. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: key + realPath: + - key + serializedName: key + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Trigger URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: triggerUrl + realPath: + - triggerUrl + serializedName: triggerUrl + serializedName: FunctionSecrets_properties + - &ref_197 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Function secrets. + name: + fixed: false + raw: FunctionSecrets + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: FunctionSecrets resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_28 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: FunctionSecrets + - &ref_33 + $type: CompositeType + containsConstantProperties: false + documentation: HostNameBinding resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: HostNameBinding_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App Service app name. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: siteName + realPath: + - siteName + serializedName: siteName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Fully qualified ARM domain resource URI. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainId + realPath: + - domainId + serializedName: domainId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Azure resource name. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: azureResourceName + realPath: + - azureResourceName + serializedName: azureResourceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Azure resource type. + extensions: + x-ms-enum: + modelAsString: false + name: AzureResourceType + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_29 + name: + fixed: false + raw: azureResourceType + realPath: + - azureResourceType + serializedName: azureResourceType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Custom DNS record type. + extensions: + x-ms-enum: + modelAsString: false + name: CustomHostNameDnsRecordType + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_30 + name: + fixed: false + raw: customHostNameDnsRecordType + realPath: + - customHostNameDnsRecordType + serializedName: customHostNameDnsRecordType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostname type. + extensions: + x-ms-enum: + modelAsString: false + name: HostNameType + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_31 + name: + fixed: false + raw: hostNameType + realPath: + - hostNameType + serializedName: hostNameType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SSL type + extensions: + x-ms-enum: + modelAsString: false + name: SslState + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_32 + name: + fixed: false + raw: sslState + realPath: + - sslState + serializedName: sslState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SSL certificate thumbprint + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprint + realPath: + - thumbprint + serializedName: thumbprint + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Virtual IP address assigned to the hostname if IP based SSL is + enabled. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: virtualIP + realPath: + - virtualIP + serializedName: virtualIP + serializedName: HostNameBinding_properties + - &ref_34 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: A hostname binding object. + name: + fixed: false + raw: HostNameBinding + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: HostNameBinding resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_33 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: HostNameBinding + - &ref_198 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of hostname bindings. + name: + fixed: false + raw: HostNameBindingCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_34 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: HostNameBindingCollection + - &ref_113 + $type: CompositeType + containsConstantProperties: false + documentation: Http logs configuration. + name: + fixed: false + raw: HttpLogsConfig + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Http logs to file system configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_35 + name: + fixed: false + raw: fileSystem + realPath: + - fileSystem + serializedName: fileSystem + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Http logs to azure blob storage configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_36 + name: + fixed: false + raw: azureBlobStorage + realPath: + - azureBlobStorage + serializedName: azureBlobStorage + serializedName: HttpLogsConfig + - &ref_37 + $type: CompositeType + containsConstantProperties: false + documentation: Identifier resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: Identifier_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: String representation of the identity. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: Identifier_properties + - &ref_38 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Identifier. + name: + fixed: false + raw: Identifier + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Identifier resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_37 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: Identifier + - &ref_191 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of identifiers. + name: + fixed: false + raw: IdentifierCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_38 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: IdentifierCollection + - &ref_39 + $type: CompositeType + containsConstantProperties: false + documentation: MSDeploy ARM PUT core information + name: + fixed: false + raw: MSDeployCore + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Package URI + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: packageUri + realPath: + - packageUri + serializedName: packageUri + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SQL Connection String + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: connectionString + realPath: + - connectionString + serializedName: connectionString + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Database Type + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: dbType + realPath: + - dbType + serializedName: dbType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + URI of MSDeploy Parameters file. Must not be set if SetParameters is + used. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: setParametersXmlFileUri + realPath: + - setParametersXmlFileUri + serializedName: setParametersXmlFileUri + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is + used. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: setParameters + realPath: + - setParameters + serializedName: setParameters + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Controls whether the MSDeploy operation skips the App_Data + directory. + + If set to true, the existing App_Data directory on the + destination + + will not be deleted, and any App_Data directory in the source will + be ignored. + + Setting is false by default. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipAppData + realPath: + - skipAppData + serializedName: skipAppData + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Sets the AppOffline rule while the MSDeploy operation executes. + Setting is false by default. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: appOffline + realPath: + - appOffline + serializedName: appOffline + serializedName: MSDeployCore + - &ref_193 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: MSDeploy ARM PUT information + name: + fixed: false + raw: MSDeploy + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Core resource properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_39 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: MSDeploy + - &ref_41 + $type: CompositeType + containsConstantProperties: false + documentation: MSDeploy log entry + name: + fixed: false + raw: MSDeployLogEntry + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Timestamp of log entry + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: time + realPath: + - time + serializedName: time + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Log entry type + extensions: + x-ms-enum: + modelAsString: false + name: MSDeployLogEntryType + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_40 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Log entry message + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: MSDeployLogEntry + - &ref_42 + $type: CompositeType + containsConstantProperties: false + documentation: MSDeployLog resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: MSDeployLog_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of log entry messages + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_41 + name: + fixed: false + name: + fixed: false + raw: entries + realPath: + - entries + serializedName: entries + serializedName: MSDeployLog_properties + - &ref_194 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: MSDeploy log + name: + fixed: false + raw: MSDeployLog + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: MSDeployLog resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_42 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: MSDeployLog + - &ref_44 + $type: CompositeType + containsConstantProperties: false + documentation: MSDeployStatus resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: MSDeployStatus_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Username of deployer + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: deployer + realPath: + - deployer + serializedName: deployer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Provisioning state + extensions: + x-ms-enum: + modelAsString: false + name: MSDeployProvisioningState + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_43 + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start time of deploy operation + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: End time of deploy operation + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Whether the deployment operation has completed + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: complete + realPath: + - complete + serializedName: complete + serializedName: MSDeployStatus_properties + - &ref_192 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: MSDeploy ARM response + name: + fixed: false + raw: MSDeployStatus + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: MSDeployStatus resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_44 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: MSDeployStatus + - &ref_46 + $type: CompositeType + containsConstantProperties: false + documentation: MigrateMySqlRequest resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: MigrateMySqlRequest_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Connection string to the remote MySQL database. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: connectionString + realPath: + - connectionString + serializedName: connectionString + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The type of migration operation to be done + extensions: + x-ms-enum: + modelAsString: false + name: MySqlMigrationType + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_45 + name: + fixed: false + raw: migrationType + realPath: + - migrationType + serializedName: migrationType + serializedName: MigrateMySqlRequest_properties + - &ref_210 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: MySQL migration request. + name: + fixed: false + raw: MigrateMySqlRequest + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: MigrateMySqlRequest resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_46 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: MigrateMySqlRequest + - &ref_48 + $type: CompositeType + containsConstantProperties: false + documentation: MigrateMySqlStatus resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: MigrateMySqlStatus_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Status of the migration task. + extensions: + x-ms-enum: + modelAsString: false + name: OperationStatus + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_47 + name: + fixed: false + raw: migrationOperationStatus + realPath: + - migrationOperationStatus + serializedName: migrationOperationStatus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Operation ID for the migration task. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: operationId + realPath: + - operationId + serializedName: operationId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: True if the web app has in app MySql enabled + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: localMySqlEnabled + realPath: + - localMySqlEnabled + serializedName: localMySqlEnabled + serializedName: MigrateMySqlStatus_properties + - &ref_212 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: MySQL migration status. + name: + fixed: false + raw: MigrateMySqlStatus + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: MigrateMySqlStatus resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_48 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: MigrateMySqlStatus + - &ref_50 + $type: CompositeType + containsConstantProperties: false + documentation: VnetRoute resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: VnetRoute_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of this route. This is only returned by the server and does + not need to be set by the client. + extensions: + x-ms-client-name: vnetRouteName + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The starting address for this route. This may also include a CIDR + notation, in which case the end address must not be specified. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: startAddress + realPath: + - startAddress + serializedName: startAddress + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ending address for this route. If the start address is specified + in CIDR notation, this must be omitted. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: endAddress + realPath: + - endAddress + serializedName: endAddress + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The type of route this is: + + DEFAULT - By default, every app has routes to the local address + ranges specified by RFC1918 + + INHERITED - Routes inherited from the real Virtual Network routes + + STATIC - Static route set on the app only + + + These values will be used for syncing an app's routes with those + from a Virtual Network. + extensions: + x-ms-enum: + modelAsString: true + name: RouteType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_49 + name: + fixed: false + raw: routeType + realPath: + - routeType + serializedName: routeType + serializedName: VnetRoute_properties + - &ref_51 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: >- + Virtual Network route contract used to pass routing information for a + Virtual Network. + name: + fixed: false + raw: VnetRoute + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: VnetRoute resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_50 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VnetRoute + - &ref_52 + $type: CompositeType + containsConstantProperties: false + documentation: VnetInfo resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: VnetInfo_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Virtual Network's resource ID. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetResourceId + realPath: + - vnetResourceId + serializedName: vnetResourceId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The client certificate thumbprint. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: certThumbprint + realPath: + - certThumbprint + serializedName: certThumbprint + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A certificate file (.cer) blob containing the public key of the + private key used to authenticate a + + Point-To-Site VPN connection. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: certBlob + realPath: + - certBlob + serializedName: certBlob + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The routes that this Virtual Network connection uses. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_51 + name: + fixed: false + name: + fixed: false + raw: routes + realPath: + - routes + serializedName: routes + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if a resync is required; otherwise, + false. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: resyncRequired + realPath: + - resyncRequired + serializedName: resyncRequired + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + DNS servers to be used by this Virtual Network. This should be a + comma-separated list of IP addresses. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: dnsServers + realPath: + - dnsServers + serializedName: dnsServers + serializedName: VnetInfo_properties + - &ref_55 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Virtual Network information contract. + name: + fixed: false + raw: VnetInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: VnetInfo resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_52 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VnetInfo + - &ref_53 + $type: CompositeType + containsConstantProperties: false + documentation: RelayServiceConnectionEntity resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: RelayServiceConnectionEntity_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityName + realPath: + - entityName + serializedName: entityName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityConnectionString + realPath: + - entityConnectionString + serializedName: entityConnectionString + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceType + realPath: + - resourceType + serializedName: resourceType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceConnectionString + realPath: + - resourceConnectionString + serializedName: resourceConnectionString + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostname + realPath: + - hostname + serializedName: hostname + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: port + realPath: + - port + serializedName: port + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: biztalkUri + realPath: + - biztalkUri + serializedName: biztalkUri + serializedName: RelayServiceConnectionEntity_properties + - &ref_56 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Hybrid Connection for an App Service app. + name: + fixed: false + raw: RelayServiceConnectionEntity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: RelayServiceConnectionEntity resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_53 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: RelayServiceConnectionEntity + - &ref_54 + $type: CompositeType + containsConstantProperties: false + documentation: HybridConnection resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: HybridConnection_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the Service Bus namespace. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: serviceBusNamespace + realPath: + - serviceBusNamespace + serializedName: serviceBusNamespace + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the Service Bus relay. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + realPath: + - relayName + serializedName: relayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ARM URI to the Service Bus relay. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayArmUri + realPath: + - relayArmUri + serializedName: relayArmUri + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The hostname of the endpoint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostname + realPath: + - hostname + serializedName: hostname + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The port of the endpoint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: port + realPath: + - port + serializedName: port + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the Service Bus key which has Send permissions. This is + used to authenticate to Service Bus. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sendKeyName + realPath: + - sendKeyName + serializedName: sendKeyName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The value of the Service Bus key. This is used to authenticate to + Service Bus. In ARM this key will not be returned + + normally, use the POST /listKeys API instead. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sendKeyValue + realPath: + - sendKeyValue + serializedName: sendKeyValue + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The suffix for the service bus endpoint. By default this is + .servicebus.windows.net + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: serviceBusSuffix + realPath: + - serviceBusSuffix + serializedName: serviceBusSuffix + serializedName: HybridConnection_properties + - &ref_57 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Hybrid Connection contract. This is used to configure a Hybrid Connection. + name: + fixed: false + raw: HybridConnection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: HybridConnection resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_54 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: HybridConnection + - &ref_58 + $type: CompositeType + containsConstantProperties: false + documentation: NetworkFeatures resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: NetworkFeatures_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Virtual Network name. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: virtualNetworkName + realPath: + - virtualNetworkName + serializedName: virtualNetworkName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Virtual Network summary view. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_55 + name: + fixed: false + raw: virtualNetworkConnection + realPath: + - virtualNetworkConnection + serializedName: virtualNetworkConnection + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Hybrid Connections summary view. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_56 + name: + fixed: false + name: + fixed: false + raw: hybridConnections + realPath: + - hybridConnections + serializedName: hybridConnections + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Hybrid Connection V2 (Service Bus) view. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_57 + name: + fixed: false + name: + fixed: false + raw: hybridConnectionsV2 + realPath: + - hybridConnectionsV2 + serializedName: hybridConnectionsV2 + serializedName: NetworkFeatures_properties + - &ref_213 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: >- + Full view of network features for an app (presently VNET integration and + Hybrid Connections). + name: + fixed: false + raw: NetworkFeatures + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: NetworkFeatures resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_58 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: NetworkFeatures + - &ref_59 + $type: CompositeType + containsConstantProperties: false + documentation: Performance monitor sample in a set. + name: + fixed: false + raw: PerfMonSample + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Point in time for which counter was measured. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: time + realPath: + - time + serializedName: time + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the server on which the measurement is made. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceName + realPath: + - instanceName + serializedName: instanceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value of counter at a certain time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Core Count of worker. Not a data member + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: coreCount + realPath: + - coreCount + serializedName: coreCount + serializedName: PerfMonSample + - &ref_60 + $type: CompositeType + containsConstantProperties: false + documentation: Metric information. + name: + fixed: false + raw: PerfMonSet + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unique key name of the counter. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start time of the period. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: End time of the period. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Presented time grain. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timeGrain + realPath: + - timeGrain + serializedName: timeGrain + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of workers that are active during this time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_59 + name: + fixed: false + name: + fixed: false + raw: values + realPath: + - values + serializedName: values + serializedName: PerfMonSet + - &ref_61 + $type: CompositeType + containsConstantProperties: false + documentation: Performance monitor API response. + name: + fixed: false + raw: PerfMonResponse + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The response code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The message. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The performance monitor counters. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_60 + name: + fixed: false + raw: data + realPath: + - data + serializedName: data + serializedName: PerfMonResponse + - &ref_216 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of performance monitor counters. + name: + fixed: false + raw: PerfMonCounterCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_61 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: PerfMonCounterCollection + - &ref_62 + $type: CompositeType + containsConstantProperties: false + documentation: PremierAddOn resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: PremierAddOn_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sku + realPath: + - sku + serializedName: sku + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: product + realPath: + - product + serializedName: product + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Vendor. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vendor + realPath: + - vendor + serializedName: vendor + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name. + extensions: + x-ms-client-name: PremierAddOnName + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Location. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Tags. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Marketplace publisher. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: marketplacePublisher + realPath: + - marketplacePublisher + serializedName: marketplacePublisher + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Marketplace offer. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: marketplaceOffer + realPath: + - marketplaceOffer + serializedName: marketplaceOffer + serializedName: PremierAddOn_properties + - &ref_218 + $type: CompositeType + baseModelType: &ref_152 + $type: CompositeType + containsConstantProperties: false + documentation: Azure resource. This resource is tracked in Azure Resource Manager + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: Resource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Name. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Kind of resource. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: kind + realPath: + - kind + serializedName: kind + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Location. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource type. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource tags. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + serializedName: Resource + containsConstantProperties: false + documentation: Premier add-on. + name: + fixed: false + raw: PremierAddOn + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PremierAddOn resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_62 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: PremierAddOn + - &ref_63 + $type: CompositeType + containsConstantProperties: false + documentation: ProcessThreadInfo resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: ProcessThreadInfo_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ARM Identifier for deployment. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: HRef URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: href + realPath: + - href + serializedName: href + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Process URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: process + realPath: + - process + serializedName: process + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start address. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: startAddress + realPath: + - startAddress + serializedName: startAddress + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Current thread priority. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: currentPriority + realPath: + - currentPriority + serializedName: currentPriority + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Thread priority level. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: priorityLevel + realPath: + - priorityLevel + serializedName: priorityLevel + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Base priority. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: basePriority + realPath: + - basePriority + serializedName: basePriority + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Total processor time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: totalProcessorTime + realPath: + - totalProcessorTime + serializedName: totalProcessorTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: User processor time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: userProcessorTime + realPath: + - userProcessorTime + serializedName: userProcessorTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Priviledged processor time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: priviledgedProcessorTime + realPath: + - priviledgedProcessorTime + serializedName: priviledgedProcessorTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Thread state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Wait reason. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: waitReason + realPath: + - waitReason + serializedName: waitReason + serializedName: ProcessThreadInfo_properties + - &ref_65 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Process Thread Information. + name: + fixed: false + raw: ProcessThreadInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ProcessThreadInfo resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_63 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: ProcessThreadInfo + - &ref_64 + $type: CompositeType + containsConstantProperties: false + documentation: ProcessModuleInfo resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: ProcessModuleInfo_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Base address. Used as module identifier in ARM resource URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: baseAddress + realPath: + - baseAddress + serializedName: baseAddress + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: File name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: fileName + realPath: + - fileName + serializedName: fileName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: HRef URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: href + realPath: + - href + serializedName: href + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: File path. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: filePath + realPath: + - filePath + serializedName: filePath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Module memory size. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: moduleMemorySize + realPath: + - moduleMemorySize + serializedName: moduleMemorySize + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: File version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: fileVersion + realPath: + - fileVersion + serializedName: fileVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: File description. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: fileDescription + realPath: + - fileDescription + serializedName: fileDescription + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: product + realPath: + - product + serializedName: product + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Product version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: productVersion + realPath: + - productVersion + serializedName: productVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Is debug? + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isDebug + realPath: + - isDebug + serializedName: isDebug + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Module language (locale). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: language + realPath: + - language + serializedName: language + serializedName: ProcessModuleInfo_properties + - &ref_66 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Process Module Information. + name: + fixed: false + raw: ProcessModuleInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ProcessModuleInfo resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_64 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: ProcessModuleInfo + - &ref_67 + $type: CompositeType + containsConstantProperties: false + documentation: ProcessInfo resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: ProcessInfo_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ARM Identifier for deployment. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Deployment name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: HRef URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: href + realPath: + - href + serializedName: href + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Minidump URI. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: miniDump + realPath: + - miniDump + serializedName: miniDump + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Is profile running? + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isProfileRunning + realPath: + - isProfileRunning + serializedName: isProfileRunning + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Is the IIS Profile running? + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isIisProfileRunning + realPath: + - isIisProfileRunning + serializedName: isIisProfileRunning + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: IIS Profile timeout (seconds). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: iisProfileTimeoutInSeconds + realPath: + - iisProfileTimeoutInSeconds + serializedName: iisProfileTimeoutInSeconds + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parent process. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: parent + realPath: + - parent + serializedName: parent + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Child process list. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: children + realPath: + - children + serializedName: children + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Thread list. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_65 + name: + fixed: false + name: + fixed: false + raw: threads + realPath: + - threads + serializedName: threads + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of open files. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: openFileHandles + realPath: + - openFileHandles + serializedName: openFileHandles + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of modules. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_66 + name: + fixed: false + name: + fixed: false + raw: modules + realPath: + - modules + serializedName: modules + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: File name of this process. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: fileName + realPath: + - fileName + serializedName: fileName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Command line. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: commandLine + realPath: + - commandLine + serializedName: commandLine + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: User name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: userName + realPath: + - userName + serializedName: userName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Handle count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: handleCount + realPath: + - handleCount + serializedName: handleCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Module count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: moduleCount + realPath: + - moduleCount + serializedName: moduleCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Thread count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: threadCount + realPath: + - threadCount + serializedName: threadCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Total CPU time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: totalProcessorTime + realPath: + - totalProcessorTime + serializedName: totalProcessorTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: User CPU time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: userProcessorTime + realPath: + - userProcessorTime + serializedName: userProcessorTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Privileged CPU time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: privilegedProcessorTime + realPath: + - privilegedProcessorTime + serializedName: privilegedProcessorTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Working set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: workingSet64 + realPath: + - workingSet64 + serializedName: workingSet64 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Peak working set. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: peakWorkingSet64 + realPath: + - peakWorkingSet64 + serializedName: peakWorkingSet64 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Private memory size. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: privateMemorySize64 + realPath: + - privateMemorySize64 + serializedName: privateMemorySize64 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Virtual memory size. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: virtualMemorySize64 + realPath: + - virtualMemorySize64 + serializedName: virtualMemorySize64 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Peak virtual memory usage. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: peakVirtualMemorySize64 + realPath: + - peakVirtualMemorySize64 + serializedName: peakVirtualMemorySize64 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Paged system memory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: pagedSystemMemorySize64 + realPath: + - pagedSystemMemorySize64 + serializedName: pagedSystemMemorySize64 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Non-paged system memory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: nonpagedSystemMemorySize64 + realPath: + - nonpagedSystemMemorySize64 + serializedName: nonpagedSystemMemorySize64 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Paged memory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: pagedMemorySize64 + realPath: + - pagedMemorySize64 + serializedName: pagedMemorySize64 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Peak paged memory. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: peakPagedMemorySize64 + realPath: + - peakPagedMemorySize64 + serializedName: peakPagedMemorySize64 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time stamp. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: timeStamp + realPath: + - timeStamp + serializedName: timeStamp + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of environment variables. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: environmentVariables + realPath: + - environmentVariables + serializedName: environmentVariables + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Is this the SCM site? + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isScmSite + realPath: + - isScmSite + serializedName: isScmSite + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Is this a Web Job? + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isWebJob + realPath: + - isWebJob + serializedName: isWebJob + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Description of process. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + serializedName: ProcessInfo_properties + - &ref_68 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Process Information. + name: + fixed: false + raw: ProcessInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ProcessInfo resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_67 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: ProcessInfo + - &ref_201 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of Kudu process information elements. + name: + fixed: false + raw: ProcessInfoCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_68 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ProcessInfoCollection + - &ref_203 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of Kudu thread information elements. + name: + fixed: false + raw: ProcessModuleInfoCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_66 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ProcessModuleInfoCollection + - &ref_204 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of Kudu thread information elements. + name: + fixed: false + raw: ProcessThreadInfoCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_65 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ProcessThreadInfoCollection + - &ref_70 + $type: CompositeType + containsConstantProperties: false + documentation: PublicCertificate resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: PublicCertificate_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Public Certificate byte array + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: blob + realPath: + - blob + serializedName: blob + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Public Certificate Location + extensions: + x-ms-enum: + modelAsString: false + name: PublicCertificateLocation + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_69 + name: + fixed: false + raw: publicCertificateLocation + realPath: + - publicCertificateLocation + serializedName: publicCertificateLocation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Certificate Thumbprint + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprint + realPath: + - thumbprint + serializedName: thumbprint + serializedName: PublicCertificate_properties + - &ref_71 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Public certificate object + name: + fixed: false + raw: PublicCertificate + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PublicCertificate resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_70 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: PublicCertificate + - &ref_220 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of public certificates + name: + fixed: false + raw: PublicCertificateCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_71 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: PublicCertificateCollection + - &ref_72 + $type: CompositeType + containsConstantProperties: false + documentation: RestoreRequest resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: RestoreRequest_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SAS URL to the container. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: storageAccountUrl + realPath: + - storageAccountUrl + serializedName: storageAccountUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of a blob which contains the backup. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: blobName + realPath: + - blobName + serializedName: blobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if the restore operation can overwrite target app; + otherwise, false. true is needed if trying + to restore over an existing app. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: overwrite + realPath: + - overwrite + serializedName: overwrite + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of an app. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: siteName + realPath: + - siteName + serializedName: siteName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Collection of databases which should be restored. This list has to + match the list of databases included in the backup. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_6 + name: + fixed: false + name: + fixed: false + raw: databases + realPath: + - databases + serializedName: databases + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + Changes a logic when restoring an app with custom domains. + true to remove custom domains automatically. If + false, custom domains are added to + + the app's object when it is being restored, but that might fail due + to conflicts during the operation. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: ignoreConflictingHostNames + realPath: + - ignoreConflictingHostNames + serializedName: ignoreConflictingHostNames + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: Ignore the databases and only restore the site content + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: ignoreDatabases + realPath: + - ignoreDatabases + serializedName: ignoreDatabases + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specify app service plan that will own restored site. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appServicePlan + realPath: + - appServicePlan + serializedName: appServicePlan + - collectionFormat: none + defaultValue: + fixed: false + raw: Default + documentation: + fixed: false + raw: Operation type. + extensions: + x-ms-enum: + modelAsString: false + name: BackupRestoreOperationType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_11 + name: + fixed: false + raw: operationType + realPath: + - operationType + serializedName: operationType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if SiteConfig.ConnectionStrings should be set in + new app; otherwise, false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: adjustConnectionStrings + realPath: + - adjustConnectionStrings + serializedName: adjustConnectionStrings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + App Service Environment name, if needed (only when restoring an app + to an App Service Environment). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostingEnvironment + realPath: + - hostingEnvironment + serializedName: hostingEnvironment + serializedName: RestoreRequest_properties + - &ref_177 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Description of a restore request. + name: + fixed: false + raw: RestoreRequest + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: RestoreRequest resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_72 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: RestoreRequest + - &ref_73 + $type: CompositeType + containsConstantProperties: false + documentation: RestoreResponse resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: RestoreResponse_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When server starts the restore process, it will return an operation + ID identifying that particular restore operation. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: operationId + realPath: + - operationId + serializedName: operationId + serializedName: RestoreResponse_properties + - &ref_178 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Response for an app restore request. + name: + fixed: false + raw: RestoreResponse + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: RestoreResponse resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_73 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: RestoreResponse + - &ref_76 + $type: CompositeType + containsConstantProperties: false + documentation: SiteAuthSettings resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SiteAuthSettings_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if the Authentication / Authorization feature is + enabled for the current app; otherwise, false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enabled + realPath: + - enabled + serializedName: enabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The RuntimeVersion of the Authentication / Authorization feature in + use for the current app. + + The setting in this value can control the behavior of certain + features in the Authentication / Authorization module. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: runtimeVersion + realPath: + - runtimeVersion + serializedName: runtimeVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The action to take when an unauthenticated client attempts to access + the app. + extensions: + x-ms-enum: + modelAsString: false + name: UnauthenticatedClientAction + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_74 + name: + fixed: false + raw: unauthenticatedClientAction + realPath: + - unauthenticatedClientAction + serializedName: unauthenticatedClientAction + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to durably store platform-specific security tokens + that are obtained during login flows; otherwise, false. + The default is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: tokenStoreEnabled + realPath: + - tokenStoreEnabled + serializedName: tokenStoreEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + External URLs that can be redirected to as part of logging in or + logging out of the app. Note that the query string part of the URL + is ignored. + + This is an advanced setting typically only needed by Windows Store + application backends. + + Note that URLs within the current domain are always implicitly + allowed. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: allowedExternalRedirectUrls + realPath: + - allowedExternalRedirectUrls + serializedName: allowedExternalRedirectUrls + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The default authentication provider to use when multiple providers + are configured. + + This setting is only needed if multiple providers are configured and + the unauthenticated client + + action is set to "RedirectToLoginPage". + extensions: + x-ms-enum: + modelAsString: false + name: BuiltInAuthenticationProvider + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_75 + name: + fixed: false + raw: defaultProvider + realPath: + - defaultProvider + serializedName: defaultProvider + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The number of hours after session token expiration that a session + token can be used to + + call the token refresh API. The default is 72 hours. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: tokenRefreshExtensionHours + realPath: + - tokenRefreshExtensionHours + serializedName: tokenRefreshExtensionHours + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Client ID of this relying party application, known as the + client_id. + + This setting is required for enabling OpenID Connection + authentication with Azure Active Directory or + + other 3rd party OpenID Connect providers. + + More information on OpenID Connect: + http://openid.net/specs/openid-connect-core-1_0.html + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: clientId + realPath: + - clientId + serializedName: clientId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The Client Secret of this relying party application (in Azure Active + Directory, this is also referred to as the Key). + + This setting is optional. If no client secret is configured, the + OpenID Connect implicit auth flow is used to authenticate end users. + + Otherwise, the OpenID Connect Authorization Code Flow is used to + authenticate end users. + + More information on OpenID Connect: + http://openid.net/specs/openid-connect-core-1_0.html + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: clientSecret + realPath: + - clientSecret + serializedName: clientSecret + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The OpenID Connect Issuer URI that represents the entity which + issues access tokens for this application. + + When using Azure Active Directory, this value is the URI of the + directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. + + This URI is a case-sensitive identifier for the token issuer. + + More information on OpenID Connect Discovery: + http://openid.net/specs/openid-connect-discovery-1_0.html + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: issuer + realPath: + - issuer + serializedName: issuer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Allowed audience values to consider when validating JWTs issued by + + Azure Active Directory. Note that the ClientID value is + always considered an + + allowed audience, regardless of this setting. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: allowedAudiences + realPath: + - allowedAudiences + serializedName: allowedAudiences + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Login parameters to send to the OpenID Connect authorization + endpoint when + + a user logs in. Each parameter must be in the form "key=value". + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: additionalLoginParams + realPath: + - additionalLoginParams + serializedName: additionalLoginParams + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The OpenID Connect Client ID for the Google web application. + + This setting is required for enabling Google Sign-In. + + Google Sign-In documentation: + https://developers.google.com/identity/sign-in/web/ + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: googleClientId + realPath: + - googleClientId + serializedName: googleClientId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The client secret associated with the Google web application. + + This setting is required for enabling Google Sign-In. + + Google Sign-In documentation: + https://developers.google.com/identity/sign-in/web/ + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: googleClientSecret + realPath: + - googleClientSecret + serializedName: googleClientSecret + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The OAuth 2.0 scopes that will be requested as part of Google + Sign-In authentication. + + This setting is optional. If not specified, "openid", "profile", and + "email" are used as default scopes. + + Google Sign-In documentation: + https://developers.google.com/identity/sign-in/web/ + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: googleOAuthScopes + realPath: + - googleOAuthScopes + serializedName: googleOAuthScopes + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The App ID of the Facebook app used for login. + + This setting is required for enabling Facebook Login. + + Facebook Login documentation: + https://developers.facebook.com/docs/facebook-login + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: facebookAppId + realPath: + - facebookAppId + serializedName: facebookAppId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The App Secret of the Facebook app used for Facebook Login. + + This setting is required for enabling Facebook Login. + + Facebook Login documentation: + https://developers.facebook.com/docs/facebook-login + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: facebookAppSecret + realPath: + - facebookAppSecret + serializedName: facebookAppSecret + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The OAuth 2.0 scopes that will be requested as part of Facebook + Login authentication. + + This setting is optional. + + Facebook Login documentation: + https://developers.facebook.com/docs/facebook-login + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: facebookOAuthScopes + realPath: + - facebookOAuthScopes + serializedName: facebookOAuthScopes + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The OAuth 1.0a consumer key of the Twitter application used for + sign-in. + + This setting is required for enabling Twitter Sign-In. + + Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: twitterConsumerKey + realPath: + - twitterConsumerKey + serializedName: twitterConsumerKey + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The OAuth 1.0a consumer secret of the Twitter application used for + sign-in. + + This setting is required for enabling Twitter Sign-In. + + Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: twitterConsumerSecret + realPath: + - twitterConsumerSecret + serializedName: twitterConsumerSecret + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The OAuth 2.0 client ID that was created for the app used for + authentication. + + This setting is required for enabling Microsoft Account + authentication. + + Microsoft Account OAuth documentation: + https://dev.onedrive.com/auth/msa_oauth.htm + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: microsoftAccountClientId + realPath: + - microsoftAccountClientId + serializedName: microsoftAccountClientId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The OAuth 2.0 client secret that was created for the app used for + authentication. + + This setting is required for enabling Microsoft Account + authentication. + + Microsoft Account OAuth documentation: + https://dev.onedrive.com/auth/msa_oauth.htm + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: microsoftAccountClientSecret + realPath: + - microsoftAccountClientSecret + serializedName: microsoftAccountClientSecret + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The OAuth 2.0 scopes that will be requested as part of Microsoft + Account authentication. + + This setting is optional. If not specified, "wl.basic" is used as + the default scope. + + Microsoft Account Scopes and permissions documentation: + https://msdn.microsoft.com/en-us/library/dn631845.aspx + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: microsoftAccountOAuthScopes + realPath: + - microsoftAccountOAuthScopes + serializedName: microsoftAccountOAuthScopes + serializedName: SiteAuthSettings_properties + - &ref_181 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: >- + Configuration settings for the Azure App Service Authentication / + Authorization feature. + name: + fixed: false + raw: SiteAuthSettings + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SiteAuthSettings resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_76 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SiteAuthSettings + - &ref_78 + $type: CompositeType + containsConstantProperties: false + documentation: An app cloneability criterion. + name: + fixed: false + raw: SiteCloneabilityCriterion + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of criterion. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Description of criterion. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + serializedName: SiteCloneabilityCriterion + - &ref_205 + $type: CompositeType + containsConstantProperties: false + documentation: Represents whether or not an app is cloneable. + name: + fixed: false + raw: SiteCloneability + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of app. + extensions: + x-ms-enum: + modelAsString: false + name: CloneAbilityResult + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_77 + name: + fixed: false + raw: result + realPath: + - result + serializedName: result + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of features enabled on app that prevent cloning. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_78 + name: + fixed: false + name: + fixed: false + raw: blockingFeatures + realPath: + - blockingFeatures + serializedName: blockingFeatures + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + List of features enabled on app that are non-blocking but cannot be + cloned. The app can still be cloned + + but the features in this list will not be set up on cloned app. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_78 + name: + fixed: false + name: + fixed: false + raw: unsupportedFeatures + realPath: + - unsupportedFeatures + serializedName: unsupportedFeatures + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of blocking application characteristics. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_78 + name: + fixed: false + name: + fixed: false + raw: blockingCharacteristics + realPath: + - blockingCharacteristics + serializedName: blockingCharacteristics + serializedName: SiteCloneability + - &ref_89 + $type: CompositeType + containsConstantProperties: false + documentation: Name value pair. + name: + fixed: false + raw: NameValuePair + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Pair name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Pair value. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: NameValuePair + - &ref_90 + $type: CompositeType + containsConstantProperties: false + documentation: Database connection string information. + name: + fixed: false + raw: ConnStringInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of connection string. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Connection string value. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: connectionString + realPath: + - connectionString + serializedName: connectionString + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Type of database. + extensions: + x-ms-enum: + modelAsString: false + name: ConnectionStringType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_14 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + serializedName: ConnStringInfo + - &ref_91 + $type: CompositeType + containsConstantProperties: false + documentation: MachineKey of an app. + name: + fixed: false + raw: SiteMachineKey + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: MachineKey validation. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: validation + realPath: + - validation + serializedName: validation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Validation key. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: validationKey + realPath: + - validationKey + serializedName: validationKey + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Decryption. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: decryption + realPath: + - decryption + serializedName: decryption + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Decryption key. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: decryptionKey + realPath: + - decryptionKey + serializedName: decryptionKey + serializedName: SiteMachineKey + - &ref_92 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The IIS handler mappings used to define which handler processes HTTP + requests with certain extension. + + For example, it is used to configure php-cgi.exe process to handle all + HTTP requests with *.php extension. + name: + fixed: false + raw: HandlerMapping + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Requests with this extension will be handled using the specified + FastCGI application. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: extension + realPath: + - extension + serializedName: extension + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The absolute path to the FastCGI application. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scriptProcessor + realPath: + - scriptProcessor + serializedName: scriptProcessor + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Command-line arguments to be passed to the script processor. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: arguments + realPath: + - arguments + serializedName: arguments + serializedName: HandlerMapping + - &ref_79 + $type: CompositeType + containsConstantProperties: false + documentation: Directory for virtual application. + name: + fixed: false + raw: VirtualDirectory + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Path to virtual application. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: virtualPath + realPath: + - virtualPath + serializedName: virtualPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Physical path. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: physicalPath + realPath: + - physicalPath + serializedName: physicalPath + serializedName: VirtualDirectory + - &ref_95 + $type: CompositeType + containsConstantProperties: false + documentation: Virtual application in an app. + name: + fixed: false + raw: VirtualApplication + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Virtual path. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: virtualPath + realPath: + - virtualPath + serializedName: virtualPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Physical path. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: physicalPath + realPath: + - physicalPath + serializedName: physicalPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if preloading is enabled; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: preloadEnabled + realPath: + - preloadEnabled + serializedName: preloadEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Virtual directories for virtual application. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_79 + name: + fixed: false + name: + fixed: false + raw: virtualDirectories + realPath: + - virtualDirectories + serializedName: virtualDirectories + serializedName: VirtualApplication + - &ref_80 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Routing rules for ramp up testing. This rule allows to redirect static + traffic % to a slot or to gradually change routing % based on performance. + name: + fixed: false + raw: RampUpRule + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Hostname of a slot to which the traffic will be redirected if + decided to. E.g. myapp-stage.azurewebsites.net. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: actionHostName + realPath: + - actionHostName + serializedName: actionHostName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Percentage of the traffic which will be redirected to + ActionHostName. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: reroutePercentage + realPath: + - reroutePercentage + serializedName: reroutePercentage + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + In auto ramp up scenario this is the step to to add/remove from + ReroutePercentage until it reaches + + MinReroutePercentage or + MaxReroutePercentage. Site metrics are checked every N + minutes specificed in ChangeIntervalInMinutes. + + Custom decision algorithm can be provided in TiPCallback site + extension which URL can be specified in + ChangeDecisionCallbackUrl. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: changeStep + realPath: + - changeStep + serializedName: changeStep + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies interval in mimuntes to reevaluate ReroutePercentage. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: changeIntervalInMinutes + realPath: + - changeIntervalInMinutes + serializedName: changeIntervalInMinutes + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies lower boundary above which ReroutePercentage will stay. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: minReroutePercentage + realPath: + - minReroutePercentage + serializedName: minReroutePercentage + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies upper boundary below which ReroutePercentage will stay. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: maxReroutePercentage + realPath: + - maxReroutePercentage + serializedName: maxReroutePercentage + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Custom decision algorithm can be provided in TiPCallback site + extension which URL can be specified. See TiPCallback site extension + for the scaffold and contracts. + + https://www.siteextensions.net/packages/TiPCallback/ + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: changeDecisionCallbackUrl + realPath: + - changeDecisionCallbackUrl + serializedName: changeDecisionCallbackUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the routing rule. The recommended name would be to point to + the slot which will receive the traffic in the experiment. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: RampUpRule + - &ref_97 + $type: CompositeType + containsConstantProperties: false + documentation: Routing rules in production experiments. + name: + fixed: false + raw: Experiments + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of ramp-up rules. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_80 + name: + fixed: false + name: + fixed: false + raw: rampUpRules + realPath: + - rampUpRules + serializedName: rampUpRules + serializedName: Experiments + - &ref_98 + $type: CompositeType + containsConstantProperties: false + documentation: Metric limits set on an app. + name: + fixed: false + raw: SiteLimits + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Maximum allowed CPU usage percentage. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: maxPercentageCpu + realPath: + - maxPercentageCpu + serializedName: maxPercentageCpu + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Maximum allowed memory usage in MB. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: maxMemoryInMb + realPath: + - maxMemoryInMb + serializedName: maxMemoryInMb + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Maximum allowed disk size usage in MB. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: maxDiskSizeInMb + realPath: + - maxDiskSizeInMb + serializedName: maxDiskSizeInMb + serializedName: SiteLimits + - &ref_81 + $type: CompositeType + containsConstantProperties: false + documentation: Trigger based on total requests. + name: + fixed: false + raw: RequestsBasedTrigger + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: count + realPath: + - count + serializedName: count + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time interval. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timeInterval + realPath: + - timeInterval + serializedName: timeInterval + serializedName: RequestsBasedTrigger + - &ref_82 + $type: CompositeType + containsConstantProperties: false + documentation: Trigger based on status code. + name: + fixed: false + raw: StatusCodesBasedTrigger + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: HTTP status code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SubStatus. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: subStatus + realPath: + - subStatus + serializedName: subStatus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Win32 error code. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: win32Status + realPath: + - win32Status + serializedName: win32Status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: count + realPath: + - count + serializedName: count + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time interval. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timeInterval + realPath: + - timeInterval + serializedName: timeInterval + serializedName: StatusCodesBasedTrigger + - &ref_83 + $type: CompositeType + containsConstantProperties: false + documentation: Trigger based on request execution time. + name: + fixed: false + raw: SlowRequestsBasedTrigger + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time taken. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timeTaken + realPath: + - timeTaken + serializedName: timeTaken + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: count + realPath: + - count + serializedName: count + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time interval. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timeInterval + realPath: + - timeInterval + serializedName: timeInterval + serializedName: SlowRequestsBasedTrigger + - &ref_86 + $type: CompositeType + containsConstantProperties: false + documentation: Triggers for auto-heal. + name: + fixed: false + raw: AutoHealTriggers + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A rule based on total requests. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_81 + name: + fixed: false + raw: requests + realPath: + - requests + serializedName: requests + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A rule based on private bytes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: privateBytesInKB + realPath: + - privateBytesInKB + serializedName: privateBytesInKB + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A rule based on status codes. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_82 + name: + fixed: false + name: + fixed: false + raw: statusCodes + realPath: + - statusCodes + serializedName: statusCodes + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A rule based on request execution time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_83 + name: + fixed: false + raw: slowRequests + realPath: + - slowRequests + serializedName: slowRequests + serializedName: AutoHealTriggers + - &ref_85 + $type: CompositeType + containsConstantProperties: false + documentation: |- + Custom action to be executed + when an auto heal rule is triggered. + name: + fixed: false + raw: AutoHealCustomAction + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Executable to be run. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: exe + realPath: + - exe + serializedName: exe + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Parameters for the executable. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: parameters + realPath: + - parameters + serializedName: parameters + serializedName: AutoHealCustomAction + - &ref_87 + $type: CompositeType + containsConstantProperties: false + documentation: Actions which to take by the auto-heal module when a rule is triggered. + name: + fixed: false + raw: AutoHealActions + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Predefined action to be taken. + extensions: + x-ms-enum: + modelAsString: false + name: AutoHealActionType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_84 + name: + fixed: false + raw: actionType + realPath: + - actionType + serializedName: actionType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Custom action to be taken. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_85 + name: + fixed: false + raw: customAction + realPath: + - customAction + serializedName: customAction + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Minimum time the process must execute + before taking the action + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: minProcessExecutionTime + realPath: + - minProcessExecutionTime + serializedName: minProcessExecutionTime + serializedName: AutoHealActions + - &ref_99 + $type: CompositeType + containsConstantProperties: false + documentation: Rules that can be defined for auto-heal. + name: + fixed: false + raw: AutoHealRules + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Conditions that describe when to execute the auto-heal actions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_86 + name: + fixed: false + raw: triggers + realPath: + - triggers + serializedName: triggers + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Actions to be executed when a rule is triggered. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_87 + name: + fixed: false + raw: actions + realPath: + - actions + serializedName: actions + serializedName: AutoHealRules + - &ref_100 + $type: CompositeType + containsConstantProperties: false + documentation: Cross-Origin Resource Sharing (CORS) settings for the app. + name: + fixed: false + raw: CorsSettings + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets or sets the list of origins that should be allowed to make + cross-origin + + calls (for example: http://example.com:12345). Use "*" to allow all. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: allowedOrigins + realPath: + - allowedOrigins + serializedName: allowedOrigins + serializedName: CorsSettings + - &ref_88 + $type: CompositeType + containsConstantProperties: false + documentation: PushSettings resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: PushSettings_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets or sets a flag indicating whether the Push endpoint is enabled. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isPushEnabled + realPath: + - isPushEnabled + serializedName: isPushEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets or sets a JSON string containing a list of tags that are + whitelisted for use by the push registration endpoint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tagWhitelistJson + realPath: + - tagWhitelistJson + serializedName: tagWhitelistJson + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets or sets a JSON string containing a list of tags that require + user authentication to be used in the push registration endpoint. + + Tags can consist of alphanumeric characters and the following: + + '_', '@', '#', '.', ':', '-'. + + Validation should be performed at the PushRequestHandler. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tagsRequiringAuth + realPath: + - tagsRequiringAuth + serializedName: tagsRequiringAuth + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets or sets a JSON string containing a list of dynamic tags that + will be evaluated from user claims in the push registration + endpoint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: dynamicTagsJson + realPath: + - dynamicTagsJson + serializedName: dynamicTagsJson + serializedName: PushSettings_properties + - &ref_101 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Push settings for the App. + name: + fixed: false + raw: PushSettings + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PushSettings resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_88 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: PushSettings + - &ref_102 + $type: CompositeType + containsConstantProperties: false + documentation: Information about the formal API definition for the app. + name: + fixed: false + raw: ApiDefinitionInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The URL of the API definition. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + serializedName: ApiDefinitionInfo + - &ref_103 + $type: CompositeType + containsConstantProperties: false + documentation: IP security restriction on an app. + name: + fixed: false + raw: IpSecurityRestriction + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: IP address the security restriction is valid for. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ipAddress + realPath: + - ipAddress + serializedName: ipAddress + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Subnet mask for the range of IP addresses the restriction is valid + for. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subnetMask + realPath: + - subnetMask + serializedName: subnetMask + serializedName: IpSecurityRestriction + - &ref_104 + $type: CompositeType + containsConstantProperties: false + documentation: Configuration of an App Service app. + name: + fixed: false + raw: SiteConfig + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Number of workers. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: numberOfWorkers + realPath: + - numberOfWorkers + serializedName: numberOfWorkers + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Default documents. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: defaultDocuments + realPath: + - defaultDocuments + serializedName: defaultDocuments + - collectionFormat: none + defaultValue: + fixed: false + raw: v4.6 + documentation: + fixed: false + raw: .NET Framework version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: netFrameworkVersion + realPath: + - netFrameworkVersion + serializedName: netFrameworkVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Version of PHP. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: phpVersion + realPath: + - phpVersion + serializedName: phpVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Version of Python. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pythonVersion + realPath: + - pythonVersion + serializedName: pythonVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Version of Node.js. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nodeVersion + realPath: + - nodeVersion + serializedName: nodeVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Linux App Framework and version + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: linuxFxVersion + realPath: + - linuxFxVersion + serializedName: linuxFxVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if request tracing is enabled; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: requestTracingEnabled + realPath: + - requestTracingEnabled + serializedName: requestTracingEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Request tracing expiration time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: requestTracingExpirationTime + realPath: + - requestTracingExpirationTime + serializedName: requestTracingExpirationTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if remote debugging is enabled; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: remoteDebuggingEnabled + realPath: + - remoteDebuggingEnabled + serializedName: remoteDebuggingEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Remote debugging version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: remoteDebuggingVersion + realPath: + - remoteDebuggingVersion + serializedName: remoteDebuggingVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if HTTP logging is enabled; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: httpLoggingEnabled + realPath: + - httpLoggingEnabled + serializedName: httpLoggingEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: HTTP logs directory size limit. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: logsDirectorySizeLimit + realPath: + - logsDirectorySizeLimit + serializedName: logsDirectorySizeLimit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if detailed error logging is enabled; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: detailedErrorLoggingEnabled + realPath: + - detailedErrorLoggingEnabled + serializedName: detailedErrorLoggingEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Publishing user name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publishingUsername + realPath: + - publishingUsername + serializedName: publishingUsername + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application settings. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_89 + name: + fixed: false + name: + fixed: false + raw: appSettings + realPath: + - appSettings + serializedName: appSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Connection strings. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_90 + name: + fixed: false + name: + fixed: false + raw: connectionStrings + realPath: + - connectionStrings + serializedName: connectionStrings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site MachineKey. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_91 + name: + fixed: false + raw: machineKey + realPath: + - machineKey + serializedName: machineKey + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Handler mappings. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_92 + name: + fixed: false + name: + fixed: false + raw: handlerMappings + realPath: + - handlerMappings + serializedName: handlerMappings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Document root. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: documentRoot + realPath: + - documentRoot + serializedName: documentRoot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SCM type. + extensions: + x-ms-enum: + modelAsString: true + name: ScmType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_93 + name: + fixed: false + raw: scmType + realPath: + - scmType + serializedName: scmType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to use 32-bit worker process; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: use32BitWorkerProcess + realPath: + - use32BitWorkerProcess + serializedName: use32BitWorkerProcess + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if WebSocket is enabled; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: webSocketsEnabled + realPath: + - webSocketsEnabled + serializedName: webSocketsEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if Always On is enabled; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: alwaysOn + realPath: + - alwaysOn + serializedName: alwaysOn + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Java version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: javaVersion + realPath: + - javaVersion + serializedName: javaVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Java container. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: javaContainer + realPath: + - javaContainer + serializedName: javaContainer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Java container version. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: javaContainerVersion + realPath: + - javaContainerVersion + serializedName: javaContainerVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App command line to launch. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appCommandLine + realPath: + - appCommandLine + serializedName: appCommandLine + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Managed pipeline mode. + extensions: + x-ms-enum: + modelAsString: false + name: ManagedPipelineMode + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_94 + name: + fixed: false + raw: managedPipelineMode + realPath: + - managedPipelineMode + serializedName: managedPipelineMode + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Virtual applications. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_95 + name: + fixed: false + name: + fixed: false + raw: virtualApplications + realPath: + - virtualApplications + serializedName: virtualApplications + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site load balancing. + extensions: + x-ms-enum: + modelAsString: false + name: SiteLoadBalancing + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_96 + name: + fixed: false + raw: loadBalancing + realPath: + - loadBalancing + serializedName: loadBalancing + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: This is work around for polymophic types. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_97 + name: + fixed: false + raw: experiments + realPath: + - experiments + serializedName: experiments + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site limits. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_98 + name: + fixed: false + raw: limits + realPath: + - limits + serializedName: limits + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if Auto Heal is enabled; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: autoHealEnabled + realPath: + - autoHealEnabled + serializedName: autoHealEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Auto Heal rules. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_99 + name: + fixed: false + raw: autoHealRules + realPath: + - autoHealRules + serializedName: autoHealRules + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Tracing options. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tracingOptions + realPath: + - tracingOptions + serializedName: tracingOptions + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Virtual Network name. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + realPath: + - vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Cross-Origin Resource Sharing (CORS) settings. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_100 + name: + fixed: false + raw: cors + realPath: + - cors + serializedName: cors + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Push endpoint settings. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_101 + name: + fixed: false + raw: push + realPath: + - push + serializedName: push + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Information about the formal API definition for the app. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_102 + name: + fixed: false + raw: apiDefinition + realPath: + - apiDefinition + serializedName: apiDefinition + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Auto-swap slot name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: autoSwapSlotName + realPath: + - autoSwapSlotName + serializedName: autoSwapSlotName + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + true to enable local MySQL; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: localMySqlEnabled + realPath: + - localMySqlEnabled + serializedName: localMySqlEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: IP security restrictions. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_103 + name: + fixed: false + name: + fixed: false + raw: ipSecurityRestrictions + realPath: + - ipSecurityRestrictions + serializedName: ipSecurityRestrictions + serializedName: SiteConfig + - &ref_105 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Web app configuration ARM resource. + name: + fixed: false + raw: SiteConfigResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Core resource properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_104 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SiteConfigResource + - &ref_179 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of site configurations. + name: + fixed: false + raw: SiteConfigResourceCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_105 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: SiteConfigResourceCollection + - &ref_106 + $type: CompositeType + containsConstantProperties: false + documentation: SiteConfigurationSnapshotInfo resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SiteConfigurationSnapshotInfo_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time the snapshot was taken. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: time + realPath: + - time + serializedName: time + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The id of the snapshot + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: SiteConfigurationSnapshotInfo_properties + - &ref_107 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: A snapshot of a web app configuration. + name: + fixed: false + raw: SiteConfigurationSnapshotInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SiteConfigurationSnapshotInfo resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_106 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SiteConfigurationSnapshotInfo + - &ref_186 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Collection of metadata for the app configuration snapshots that can be + restored. + name: + fixed: false + raw: SiteConfigurationSnapshotInfoCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_107 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: SiteConfigurationSnapshotInfoCollection + - &ref_109 + $type: CompositeType + containsConstantProperties: false + documentation: SiteExtensionInfo resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SiteExtensionInfo_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site extension ID. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site extension title. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: title + realPath: + - title + serializedName: title + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site extension type. + extensions: + x-ms-enum: + modelAsString: false + name: SiteExtensionType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_108 + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Summary description. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: summary + realPath: + - summary + serializedName: summary + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Detailed description. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Version information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: version + realPath: + - version + serializedName: version + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Extension URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: extensionUrl + realPath: + - extensionUrl + serializedName: extensionUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Project URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: projectUrl + realPath: + - projectUrl + serializedName: projectUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Icon URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: iconUrl + realPath: + - iconUrl + serializedName: iconUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: License URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: licenseUrl + realPath: + - licenseUrl + serializedName: licenseUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Feed URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: feedUrl + realPath: + - feedUrl + serializedName: feedUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of authors. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: authors + realPath: + - authors + serializedName: authors + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Installer command line parameters. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: installationArgs + realPath: + - installationArgs + serializedName: installationArgs + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Published timestamp. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: publishedDateTime + realPath: + - publishedDateTime + serializedName: publishedDateTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Count of downloads. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: downloadCount + realPath: + - downloadCount + serializedName: downloadCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if the local version is the latest version; + false otherwise. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: localIsLatestVersion + realPath: + - localIsLatestVersion + serializedName: localIsLatestVersion + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Local path. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localPath + realPath: + - localPath + serializedName: localPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Installed timestamp. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: installedDateTime + realPath: + - installedDateTime + serializedName: installedDateTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Provisioning state. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site Extension comment. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: comment + realPath: + - comment + serializedName: comment + serializedName: SiteExtensionInfo_properties + - &ref_110 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Site Extension Information. + name: + fixed: false + raw: SiteExtensionInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SiteExtensionInfo resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_109 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SiteExtensionInfo + - &ref_223 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of Kudu site extension information elements. + name: + fixed: false + raw: SiteExtensionInfoCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_110 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: SiteExtensionInfoCollection + - &ref_111 + $type: CompositeType + containsConstantProperties: false + documentation: SiteInstance resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SiteInstance_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of instance. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: SiteInstance_properties + - &ref_143 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Instance of an app. + name: + fixed: false + raw: SiteInstance + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SiteInstance resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_111 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SiteInstance + - &ref_115 + $type: CompositeType + containsConstantProperties: false + documentation: SiteLogsConfig resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SiteLogsConfig_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application logs configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_112 + name: + fixed: false + raw: applicationLogs + realPath: + - applicationLogs + serializedName: applicationLogs + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: HTTP logs configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_113 + name: + fixed: false + raw: httpLogs + realPath: + - httpLogs + serializedName: httpLogs + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Failed requests tracing configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_114 + name: + fixed: false + raw: failedRequestsTracing + realPath: + - failedRequestsTracing + serializedName: failedRequestsTracing + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Detailed error messages configuration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_114 + name: + fixed: false + raw: detailedErrorMessages + realPath: + - detailedErrorMessages + serializedName: detailedErrorMessages + serializedName: SiteLogsConfig_properties + - &ref_183 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Configuration of App Service site logs. + name: + fixed: false + raw: SiteLogsConfig + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SiteLogsConfig resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_115 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SiteLogsConfig + - &ref_121 + $type: CompositeType + containsConstantProperties: false + documentation: SSL-enabled hostname. + name: + fixed: false + raw: HostNameSslState + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostname. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SSL type. + extensions: + x-ms-enum: + modelAsString: false + name: SslState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_32 + name: + fixed: false + raw: sslState + realPath: + - sslState + serializedName: sslState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Virtual IP address assigned to the hostname if IP based SSL is + enabled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: virtualIP + realPath: + - virtualIP + serializedName: virtualIP + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SSL certificate thumbprint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: thumbprint + realPath: + - thumbprint + serializedName: thumbprint + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Set to true to update existing hostname. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: toUpdate + realPath: + - toUpdate + serializedName: toUpdate + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Indicates whether the hostname is a standard or repository hostname. + extensions: + x-ms-enum: + modelAsString: false + name: HostType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_116 + name: + fixed: false + raw: hostType + realPath: + - hostType + serializedName: hostType + serializedName: HostNameSslState + - &ref_122 + $type: CompositeType + containsConstantProperties: false + documentation: Specification for an App Service Environment to use for this resource. + name: + fixed: false + raw: HostingEnvironmentProfile + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource ID of the App Service Environment. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the App Service Environment. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource type of the App Service Environment. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + serializedName: HostingEnvironmentProfile + - &ref_123 + $type: CompositeType + containsConstantProperties: false + documentation: Information needed for cloning operation. + name: + fixed: false + raw: CloningInfo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Correlation ID of cloning operation. This ID ties multiple cloning + operations + + together to use the same snapshot. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: correlationId + realPath: + - correlationId + serializedName: correlationId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to overwrite destination app; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: overwrite + realPath: + - overwrite + serializedName: overwrite + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to clone custom hostnames from source app; + otherwise, false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: cloneCustomHostNames + realPath: + - cloneCustomHostNames + serializedName: cloneCustomHostNames + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to clone source control from source app; + otherwise, false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: cloneSourceControl + realPath: + - cloneSourceControl + serializedName: cloneSourceControl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ARM resource ID of the source app. App resource ID is of the form + + /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} + for production slots and + + /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} + for other slots. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sourceWebAppId + realPath: + - sourceWebAppId + serializedName: sourceWebAppId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App Service Environment. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostingEnvironment + realPath: + - hostingEnvironment + serializedName: hostingEnvironment + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Application setting overrides for cloned app. If specified, these + settings override the settings cloned + + from source app. Otherwise, application settings from source app are + retained. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: appSettingsOverrides + realPath: + - appSettingsOverrides + serializedName: appSettingsOverrides + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to configure load balancing for source and + destination app. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: configureLoadBalancing + realPath: + - configureLoadBalancing + serializedName: configureLoadBalancing + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ARM resource ID of the Traffic Manager profile to use, if it exists. + Traffic Manager resource ID is of the form + + /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: trafficManagerProfileId + realPath: + - trafficManagerProfileId + serializedName: trafficManagerProfileId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of Traffic Manager profile to create. This is only needed if + Traffic Manager profile does not already exist. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: trafficManagerProfileName + realPath: + - trafficManagerProfileName + serializedName: trafficManagerProfileName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if quotas should be ignored; otherwise, + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: ignoreQuotas + realPath: + - ignoreQuotas + serializedName: ignoreQuotas + serializedName: CloningInfo + - &ref_117 + $type: CompositeType + containsConstantProperties: false + documentation: Specifies the web app that snapshot contents will be written to. + name: + fixed: false + raw: SnapshotRecoveryTarget + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Geographical location of the target web app, e.g. SouthEastAsia, + SouthCentralUS + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ARM resource ID of the target app. + + /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} + for production slots and + + /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} + for other slots. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: SnapshotRecoveryTarget + - &ref_118 + $type: CompositeType + containsConstantProperties: false + documentation: SnapshotRecoveryRequest resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SnapshotRecoveryRequest_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Point in time in which the app recovery should be attempted, + formatted as a DateTime string. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: snapshotTime + realPath: + - snapshotTime + serializedName: snapshotTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies the web app that snapshot contents will be written to. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_117 + name: + fixed: false + raw: recoveryTarget + realPath: + - recoveryTarget + serializedName: recoveryTarget + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true the recovery operation can overwrite source + app; otherwise, false. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: overwrite + realPath: + - overwrite + serializedName: overwrite + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true, site configuration, in addition to content, will be + reverted. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: recoverConfiguration + realPath: + - recoverConfiguration + serializedName: recoverConfiguration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true, custom hostname conflicts will be ignored when recovering + to a target web app. + + This setting is only necessary when RecoverConfiguration is enabled. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: ignoreConflictingHostNames + realPath: + - ignoreConflictingHostNames + serializedName: ignoreConflictingHostNames + serializedName: SnapshotRecoveryRequest_properties + - &ref_124 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Details about app recovery operation. + name: + fixed: false + raw: SnapshotRecoveryRequest + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SnapshotRecoveryRequest resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_118 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SnapshotRecoveryRequest + - &ref_125 + $type: CompositeType + containsConstantProperties: false + documentation: The status of the last successfull slot swap operation. + name: + fixed: false + raw: SlotSwapStatus + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time the last successful slot swap completed. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: timestampUtc + realPath: + - timestampUtc + serializedName: timestampUtc + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The source slot of the last swap operation. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sourceSlotName + realPath: + - sourceSlotName + serializedName: sourceSlotName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The destination slot of the last swap operation. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: destinationSlotName + realPath: + - destinationSlotName + serializedName: destinationSlotName + serializedName: SlotSwapStatus + - &ref_126 + $type: CompositeType + containsConstantProperties: false + documentation: SitePatchResource resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SitePatchResource_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Current state of the app. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostnames associated with the app. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: hostNames + realPath: + - hostNames + serializedName: hostNames + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the repository site. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: repositorySiteName + realPath: + - repositorySiteName + serializedName: repositorySiteName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + State indicating whether the app has exceeded its quota usage. + Read-only. + extensions: + x-ms-enum: + modelAsString: false + name: UsageState + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_119 + name: + fixed: false + raw: usageState + realPath: + - usageState + serializedName: usageState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if the app is enabled; otherwise, + false. Setting this value to false disables the app + (takes the app offline). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enabled + realPath: + - enabled + serializedName: enabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Enabled hostnames for the app.Hostnames need to be assigned (see + HostNames) AND enabled. Otherwise, + + the app is not served on those hostnames. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: enabledHostNames + realPath: + - enabledHostNames + serializedName: enabledHostNames + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Management information availability state for the app. + extensions: + x-ms-enum: + modelAsString: false + name: SiteAvailabilityState + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_120 + name: + fixed: false + raw: availabilityState + realPath: + - availabilityState + serializedName: availabilityState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Hostname SSL states are used to manage the SSL bindings for app's + hostnames. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_121 + name: + fixed: false + name: + fixed: false + raw: hostNameSslStates + realPath: + - hostNameSslStates + serializedName: hostNameSslStates + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Resource ID of the associated App Service plan, formatted as: + "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: serverFarmId + realPath: + - serverFarmId + serializedName: serverFarmId + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: 'true if reserved; otherwise, false.' + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: reserved + realPath: + - reserved + serializedName: reserved + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Last time the app was modified, in UTC. Read-only.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastModifiedTimeUtc + realPath: + - lastModifiedTimeUtc + serializedName: lastModifiedTimeUtc + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Configuration of the app. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_104 + name: + fixed: false + raw: siteConfig + realPath: + - siteConfig + serializedName: siteConfig + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Azure Traffic Manager hostnames associated with the app. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: trafficManagerHostNames + realPath: + - trafficManagerHostNames + serializedName: trafficManagerHostNames + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + true to stop SCM (KUDU) site when the app is stopped; + otherwise, false. The default is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: scmSiteAlsoStopped + realPath: + - scmSiteAlsoStopped + serializedName: scmSiteAlsoStopped + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies which deployment slot this app will swap into. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: targetSwapSlot + realPath: + - targetSwapSlot + serializedName: targetSwapSlot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App Service Environment to use for the app. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_122 + name: + fixed: false + raw: hostingEnvironmentProfile + realPath: + - hostingEnvironmentProfile + serializedName: hostingEnvironmentProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to enable client affinity; false to + stop sending session affinity cookies, which route client requests + in the same session to the same instance. Default is + true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: clientAffinityEnabled + realPath: + - clientAffinityEnabled + serializedName: clientAffinityEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to enable client certificate authentication (TLS + mutual authentication); otherwise, false. Default is + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: clientCertEnabled + realPath: + - clientCertEnabled + serializedName: clientCertEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to disable the public hostnames of the app; + otherwise, false. + If true, the app is only accessible via API management process. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: hostNamesDisabled + realPath: + - hostNamesDisabled + serializedName: hostNamesDisabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + List of IP addresses that the app uses for outbound connections + (e.g. database access). Includes VIPs from tenants that site can be + hosted with current settings. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: outboundIpAddresses + realPath: + - outboundIpAddresses + serializedName: outboundIpAddresses + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + List of IP addresses that the app uses for outbound connections + (e.g. database access). Includes VIPs from all tenants. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: possibleOutboundIpAddresses + realPath: + - possibleOutboundIpAddresses + serializedName: possibleOutboundIpAddresses + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Size of the function container. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: containerSize + realPath: + - containerSize + serializedName: containerSize + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Maximum allowed daily memory-time quota (applicable on dynamic apps + only). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: dailyMemoryTimeQuota + realPath: + - dailyMemoryTimeQuota + serializedName: dailyMemoryTimeQuota + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App suspended till in case memory-time quota is exceeded. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: suspendedTill + realPath: + - suspendedTill + serializedName: suspendedTill + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Maximum number of workers. + This only applies to Functions container. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxNumberOfWorkers + realPath: + - maxNumberOfWorkers + serializedName: maxNumberOfWorkers + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If specified during app creation, the app is cloned from a source + app. + extensions: + x-ms-mutability: + - create + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_123 + name: + fixed: false + raw: cloningInfo + realPath: + - cloningInfo + serializedName: cloningInfo + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If specified during app creation, the app is created from a previous + snapshot. + extensions: + x-ms-mutability: + - create + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_124 + name: + fixed: false + raw: snapshotInfo + realPath: + - snapshotInfo + serializedName: snapshotInfo + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group the app belongs to. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroup + realPath: + - resourceGroup + serializedName: resourceGroup + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if the app is a default container; otherwise, + false. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isDefaultContainer + realPath: + - isDefaultContainer + serializedName: isDefaultContainer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Default hostname of the app. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: defaultHostName + realPath: + - defaultHostName + serializedName: defaultHostName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Status of the last deployment slot swap operation. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_125 + name: + fixed: false + raw: slotSwapStatus + realPath: + - slotSwapStatus + serializedName: slotSwapStatus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + HttpsOnly: configures a web site to accept only https requests. + Issues redirect for + + http requests + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: httpsOnly + realPath: + - httpsOnly + serializedName: httpsOnly + serializedName: SitePatchResource_properties + - &ref_172 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: ARM resource for a site. + name: + fixed: false + raw: SitePatchResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SitePatchResource resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_126 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SitePatchResource + - &ref_127 + $type: CompositeType + containsConstantProperties: false + documentation: SitePhpErrorLogFlag resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SitePhpErrorLogFlag_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Local log_errors setting. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localLogErrors + realPath: + - localLogErrors + serializedName: localLogErrors + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Master log_errors setting. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: masterLogErrors + realPath: + - masterLogErrors + serializedName: masterLogErrors + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Local log_errors_max_len setting. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localLogErrorsMaxLength + realPath: + - localLogErrorsMaxLength + serializedName: localLogErrorsMaxLength + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Master log_errors_max_len setting. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: masterLogErrorsMaxLength + realPath: + - masterLogErrorsMaxLength + serializedName: masterLogErrorsMaxLength + serializedName: SitePhpErrorLogFlag_properties + - &ref_217 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Used for getting PHP error logging flag. + name: + fixed: false + raw: SitePhpErrorLogFlag + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SitePhpErrorLogFlag resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_127 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SitePhpErrorLogFlag + - &ref_128 + $type: CompositeType + containsConstantProperties: false + documentation: SiteSourceControl resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SiteSourceControl_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Repository or source control URL. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: repoUrl + realPath: + - repoUrl + serializedName: repoUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of branch to use for deployment. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: branch + realPath: + - branch + serializedName: branch + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to limit to manual integration; false + to enable continuous integration (which configures webhooks into + online repos like GitHub). + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isManualIntegration + realPath: + - isManualIntegration + serializedName: isManualIntegration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to enable deployment rollback; otherwise, + false. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: deploymentRollbackEnabled + realPath: + - deploymentRollbackEnabled + serializedName: deploymentRollbackEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true for a Mercurial repository; false for + a Git repository. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isMercurial + realPath: + - isMercurial + serializedName: isMercurial + serializedName: SiteSourceControl_properties + - &ref_234 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Source control configuration for an app. + name: + fixed: false + raw: SiteSourceControl + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SiteSourceControl resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_128 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SiteSourceControl + - &ref_129 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Names for connection strings and application settings to be marked as + sticky to the deployment slot and not moved during a swap operation. + + This is valid for all deployment slots in an app. + name: + fixed: false + raw: SlotConfigNames + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of connection string names. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: connectionStringNames + realPath: + - connectionStringNames + serializedName: connectionStringNames + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of application settings names. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: appSettingNames + realPath: + - appSettingNames + serializedName: appSettingNames + serializedName: SlotConfigNames + - &ref_185 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Slot Config names azure resource. + name: + fixed: false + raw: SlotConfigNamesResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Core resource properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_129 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SlotConfigNamesResource + - &ref_130 + $type: CompositeType + containsConstantProperties: false + documentation: SlotDifference resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: SlotDifference_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Type of the difference: Information, Warning or Error.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'The type of the setting: General, AppSetting or ConnectionString.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: settingType + realPath: + - settingType + serializedName: settingType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Rule that describes how to process the setting difference during a + slot swap. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: diffRule + realPath: + - diffRule + serializedName: diffRule + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the setting. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: settingName + realPath: + - settingName + serializedName: settingName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value of the setting in the current slot. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: valueInCurrentSlot + realPath: + - valueInCurrentSlot + serializedName: valueInCurrentSlot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value of the setting in the target slot. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: valueInTargetSlot + realPath: + - valueInTargetSlot + serializedName: valueInTargetSlot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Description of the setting difference. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: description + realPath: + - description + serializedName: description + serializedName: SlotDifference_properties + - &ref_131 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: A setting difference between two deployment slots of an app. + name: + fixed: false + raw: SlotDifference + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: SlotDifference resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_130 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: SlotDifference + - &ref_232 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of slot differences. + name: + fixed: false + raw: SlotDifferenceCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_131 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: SlotDifferenceCollection + - &ref_132 + $type: CompositeType + containsConstantProperties: false + documentation: Snapshot resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: Snapshot_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The time the snapshot was taken. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: time + realPath: + - time + serializedName: time + serializedName: Snapshot_properties + - &ref_133 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: A snapshot of an app. + name: + fixed: false + raw: Snapshot + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Snapshot resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_132 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: Snapshot + - &ref_233 + $type: CompositeType + containsConstantProperties: false + documentation: >- + Collection of snapshots which can be used to revert an app to a previous + time. + name: + fixed: false + raw: SnapshotCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_133 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: SnapshotCollection + - &ref_134 + $type: CompositeType + containsConstantProperties: false + documentation: StorageMigrationOptions resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: StorageMigrationOptions_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: AzureFiles connection string. + extensions: + x-ms-mutability: + - create + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: azurefilesConnectionString + realPath: + - azurefilesConnectionString + serializedName: azurefilesConnectionString + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: AzureFiles share. + extensions: + x-ms-mutability: + - create + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: azurefilesShare + realPath: + - azurefilesShare + serializedName: azurefilesShare + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + trueif the app should be switched over; otherwise, + false. + extensions: + x-ms-mutability: + - create + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: switchSiteAfterMigration + realPath: + - switchSiteAfterMigration + serializedName: switchSiteAfterMigration + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + true if the app should be read only during copy + operation; otherwise, false. + extensions: + x-ms-mutability: + - create + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: blockWriteAccessToSite + realPath: + - blockWriteAccessToSite + serializedName: blockWriteAccessToSite + serializedName: StorageMigrationOptions_properties + - &ref_208 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Options for app content migration. + name: + fixed: false + raw: StorageMigrationOptions + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: StorageMigrationOptions resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_134 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: StorageMigrationOptions + - &ref_135 + $type: CompositeType + containsConstantProperties: false + documentation: StorageMigrationResponse resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: StorageMigrationResponse_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + When server starts the migration process, it will return an + operation ID identifying that particular migration operation. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: operationId + realPath: + - operationId + serializedName: operationId + serializedName: StorageMigrationResponse_properties + - &ref_209 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Response for a migration of app content request. + name: + fixed: false + raw: StorageMigrationResponse + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: StorageMigrationResponse resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_135 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: StorageMigrationResponse + - &ref_180 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: String dictionary resource. + name: + fixed: false + raw: StringDictionary + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Settings. + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: StringDictionary + - &ref_137 + $type: CompositeType + containsConstantProperties: false + documentation: TriggeredJobRun resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: TriggeredJobRun_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job ID. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job name. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job status. + extensions: + x-ms-enum: + modelAsString: false + name: TriggeredWebJobStatus + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_136 + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Start time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: End time. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job duration. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: duration + realPath: + - duration + serializedName: duration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Output URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: outputUrl + realPath: + - outputUrl + serializedName: outputUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Error URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: errorUrl + realPath: + - errorUrl + serializedName: errorUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: jobName + realPath: + - jobName + serializedName: jobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job trigger. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: trigger + realPath: + - trigger + serializedName: trigger + serializedName: TriggeredJobRun_properties + - &ref_138 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Triggered Web Job Run Information. + name: + fixed: false + raw: TriggeredJobRun + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: TriggeredJobRun resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_137 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: TriggeredJobRun + - &ref_139 + $type: CompositeType + containsConstantProperties: false + documentation: TriggeredJobHistory resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: TriggeredJobHistory_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: List of triggered web job runs. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_138 + name: + fixed: false + name: + fixed: false + raw: triggeredJobRuns + realPath: + - triggeredJobRuns + serializedName: triggeredJobRuns + serializedName: TriggeredJobHistory_properties + - &ref_140 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: >- + Triggered Web Job History. List of Triggered Web Job Run Information + elements. + name: + fixed: false + raw: TriggeredJobHistory + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: TriggeredJobHistory resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_139 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: TriggeredJobHistory + - &ref_236 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of Kudu continuous web job information elements. + name: + fixed: false + raw: TriggeredJobHistoryCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_140 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: TriggeredJobHistoryCollection + - &ref_141 + $type: CompositeType + containsConstantProperties: false + documentation: TriggeredWebJob resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: TriggeredWebJob_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Latest job run information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_138 + name: + fixed: false + raw: latestRun + realPath: + - latestRun + serializedName: latestRun + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: History URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: historyUrl + realPath: + - historyUrl + serializedName: historyUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Scheduler Logs URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: schedulerLogsUrl + realPath: + - schedulerLogsUrl + serializedName: schedulerLogsUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job name. Used as job identifier in ARM resource URI. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Run command. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: runCommand + realPath: + - runCommand + serializedName: runCommand + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Extra Info URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: extraInfoUrl + realPath: + - extraInfoUrl + serializedName: extraInfoUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job type. + extensions: + x-ms-enum: + modelAsString: false + name: WebJobType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_17 + name: + fixed: false + raw: jobType + realPath: + - jobType + serializedName: jobType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Error information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Using SDK? + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: usingSdk + realPath: + - usingSdk + serializedName: usingSdk + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job settings. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: settings + realPath: + - settings + serializedName: settings + serializedName: TriggeredWebJob_properties + - &ref_142 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Triggered Web Job Information. + name: + fixed: false + raw: TriggeredWebJob + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: TriggeredWebJob resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_141 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: TriggeredWebJob + - &ref_235 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of Kudu continuous web job information elements. + name: + fixed: false + raw: TriggeredWebJobCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_142 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: TriggeredWebJobCollection + - &ref_200 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of app instances. + name: + fixed: false + raw: WebAppInstanceCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_143 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: WebAppInstanceCollection + - &ref_144 + $type: CompositeType + containsConstantProperties: false + documentation: WebJob resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: WebJob_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job name. Used as job identifier in ARM resource URI. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Run command. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: runCommand + realPath: + - runCommand + serializedName: runCommand + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: url + realPath: + - url + serializedName: url + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Extra Info URL. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: extraInfoUrl + realPath: + - extraInfoUrl + serializedName: extraInfoUrl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job type. + extensions: + x-ms-enum: + modelAsString: false + name: WebJobType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_17 + name: + fixed: false + raw: jobType + realPath: + - jobType + serializedName: jobType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Error information. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: error + realPath: + - error + serializedName: error + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Using SDK? + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: usingSdk + realPath: + - usingSdk + serializedName: usingSdk + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Job settings. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: settings + realPath: + - settings + serializedName: settings + serializedName: WebJob_properties + - &ref_145 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Web Job Information. + name: + fixed: false + raw: WebJob + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: WebJob resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_144 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: WebJob + - &ref_240 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of Kudu web job information elements. + name: + fixed: false + raw: WebJobCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_145 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: WebJobCollection + - &ref_146 + $type: CompositeType + containsConstantProperties: false + documentation: VnetGateway resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: VnetGateway_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Virtual Network name. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + realPath: + - vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The URI where the VPN package can be downloaded. + extensions: + x-ms-mutability: + - create + - update + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vpnPackageUri + realPath: + - vpnPackageUri + serializedName: vpnPackageUri + serializedName: VnetGateway_properties + - &ref_239 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: >- + The Virtual Network gateway contract. This is used to give the Virtual + Network gateway access to the VPN package. + name: + fixed: false + raw: VnetGateway + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: VnetGateway resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_146 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: VnetGateway + - &ref_147 + $type: CompositeType + containsConstantProperties: false + documentation: User resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: User_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Username + extensions: + x-ms-client-name: UserName + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Username used for publishing. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publishingUserName + realPath: + - publishingUserName + serializedName: publishingUserName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Password used for publishing. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: password + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publishingPassword + realPath: + - publishingPassword + serializedName: publishingPassword + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Password hash used for publishing. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: password + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publishingPasswordHash + realPath: + - publishingPasswordHash + serializedName: publishingPasswordHash + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Password hash salt used for publishing. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: password + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publishingPasswordHashSalt + realPath: + - publishingPasswordHashSalt + serializedName: publishingPasswordHashSalt + serializedName: User_properties + - &ref_184 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: User crendentials used for publishing activity. + name: + fixed: false + raw: User + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: User resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_147 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: User + - &ref_149 + $type: CompositeType + containsConstantProperties: false + documentation: Metrics availability and retention. + name: + fixed: false + raw: ResourceMetricAvailability + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time grain . + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timeGrain + realPath: + - timeGrain + serializedName: timeGrain + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Retention period for the current time grain. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: retention + realPath: + - retention + serializedName: retention + serializedName: ResourceMetricAvailability + - &ref_148 + $type: CompositeType + containsConstantProperties: false + documentation: Name of a metric for any resource . + name: + fixed: false + raw: ResourceMetricName + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: metric name value. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Localized metric name value. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localizedValue + realPath: + - localizedValue + serializedName: localizedValue + serializedName: ResourceMetricName + - &ref_150 + $type: CompositeType + containsConstantProperties: false + documentation: ResourceMetricDefinition resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: ResourceMetricDefinition_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the metric. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_148 + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unit of the metric. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: unit + realPath: + - unit + serializedName: unit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Primary aggregation type. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: primaryAggregationType + realPath: + - primaryAggregationType + serializedName: primaryAggregationType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + List of time grains supported for the metric together with retention + period. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_149 + name: + fixed: false + name: + fixed: false + raw: metricAvailabilities + realPath: + - metricAvailabilities + serializedName: metricAvailabilities + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource URI. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceUri + realPath: + - resourceUri + serializedName: resourceUri + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource ID. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Properties. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: ResourceMetricDefinition_properties + - &ref_166 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: Metadata for the metrics. + name: + fixed: false + raw: ResourceMetricDefinition + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ResourceMetricDefinition resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_150 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: ResourceMetricDefinition + - &ref_151 + $type: CompositeType + containsConstantProperties: false + documentation: HybridConnectionKey resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: HybridConnectionKey_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the send key. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sendKeyName + realPath: + - sendKeyName + serializedName: sendKeyName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The value of the send key. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sendKeyValue + realPath: + - sendKeyValue + serializedName: sendKeyValue + serializedName: HybridConnectionKey_properties + - &ref_199 + $type: CompositeType + baseModelType: *ref_12 + containsConstantProperties: false + documentation: >- + Hybrid Connection key contract. This has the send key name and value for a + Hybrid Connection. + name: + fixed: false + raw: HybridConnectionKey + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: HybridConnectionKey resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_151 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: HybridConnectionKey + - *ref_12 + - &ref_154 + $type: CompositeType + containsConstantProperties: false + documentation: Managed service identity. + name: + fixed: false + raw: ManagedServiceIdentity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Type of managed service identity. + extensions: + x-ms-enum: + modelAsString: true + name: ManagedServiceIdentityType + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: object + name: + fixed: false + raw: Object + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Tenant of managed service identity. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tenantId + realPath: + - tenantId + serializedName: tenantId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Principal Id of managed service identity. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: principalId + realPath: + - principalId + serializedName: principalId + serializedName: ManagedServiceIdentity + - &ref_153 + $type: CompositeType + containsConstantProperties: false + documentation: Site resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: Site_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Current state of the app. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: state + realPath: + - state + serializedName: state + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostnames associated with the app. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: hostNames + realPath: + - hostNames + serializedName: hostNames + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the repository site. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: repositorySiteName + realPath: + - repositorySiteName + serializedName: repositorySiteName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + State indicating whether the app has exceeded its quota usage. + Read-only. + extensions: + x-ms-enum: + modelAsString: false + name: UsageState + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_119 + name: + fixed: false + raw: usageState + realPath: + - usageState + serializedName: usageState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if the app is enabled; otherwise, + false. Setting this value to false disables the app + (takes the app offline). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: enabled + realPath: + - enabled + serializedName: enabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Enabled hostnames for the app.Hostnames need to be assigned (see + HostNames) AND enabled. Otherwise, + + the app is not served on those hostnames. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: enabledHostNames + realPath: + - enabledHostNames + serializedName: enabledHostNames + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Management information availability state for the app. + extensions: + x-ms-enum: + modelAsString: false + name: SiteAvailabilityState + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_120 + name: + fixed: false + raw: availabilityState + realPath: + - availabilityState + serializedName: availabilityState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Hostname SSL states are used to manage the SSL bindings for app's + hostnames. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_121 + name: + fixed: false + name: + fixed: false + raw: hostNameSslStates + realPath: + - hostNameSslStates + serializedName: hostNameSslStates + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Resource ID of the associated App Service plan, formatted as: + "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: serverFarmId + realPath: + - serverFarmId + serializedName: serverFarmId + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: 'true if reserved; otherwise, false.' + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: reserved + realPath: + - reserved + serializedName: reserved + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Last time the app was modified, in UTC. Read-only.' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastModifiedTimeUtc + realPath: + - lastModifiedTimeUtc + serializedName: lastModifiedTimeUtc + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Configuration of the app. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_104 + name: + fixed: false + raw: siteConfig + realPath: + - siteConfig + serializedName: siteConfig + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Azure Traffic Manager hostnames associated with the app. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: trafficManagerHostNames + realPath: + - trafficManagerHostNames + serializedName: trafficManagerHostNames + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + true to stop SCM (KUDU) site when the app is stopped; + otherwise, false. The default is false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: scmSiteAlsoStopped + realPath: + - scmSiteAlsoStopped + serializedName: scmSiteAlsoStopped + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies which deployment slot this app will swap into. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: targetSwapSlot + realPath: + - targetSwapSlot + serializedName: targetSwapSlot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App Service Environment to use for the app. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_122 + name: + fixed: false + raw: hostingEnvironmentProfile + realPath: + - hostingEnvironmentProfile + serializedName: hostingEnvironmentProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to enable client affinity; false to + stop sending session affinity cookies, which route client requests + in the same session to the same instance. Default is + true. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: clientAffinityEnabled + realPath: + - clientAffinityEnabled + serializedName: clientAffinityEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to enable client certificate authentication (TLS + mutual authentication); otherwise, false. Default is + false. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: clientCertEnabled + realPath: + - clientCertEnabled + serializedName: clientCertEnabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true to disable the public hostnames of the app; + otherwise, false. + If true, the app is only accessible via API management process. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: hostNamesDisabled + realPath: + - hostNamesDisabled + serializedName: hostNamesDisabled + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + List of IP addresses that the app uses for outbound connections + (e.g. database access). Includes VIPs from tenants that site can be + hosted with current settings. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: outboundIpAddresses + realPath: + - outboundIpAddresses + serializedName: outboundIpAddresses + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + List of IP addresses that the app uses for outbound connections + (e.g. database access). Includes VIPs from all tenants. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: possibleOutboundIpAddresses + realPath: + - possibleOutboundIpAddresses + serializedName: possibleOutboundIpAddresses + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Size of the function container. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: containerSize + realPath: + - containerSize + serializedName: containerSize + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Maximum allowed daily memory-time quota (applicable on dynamic apps + only). + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: dailyMemoryTimeQuota + realPath: + - dailyMemoryTimeQuota + serializedName: dailyMemoryTimeQuota + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App suspended till in case memory-time quota is exceeded. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: suspendedTill + realPath: + - suspendedTill + serializedName: suspendedTill + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: |- + Maximum number of workers. + This only applies to Functions container. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxNumberOfWorkers + realPath: + - maxNumberOfWorkers + serializedName: maxNumberOfWorkers + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If specified during app creation, the app is cloned from a source + app. + extensions: + x-ms-mutability: + - create + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_123 + name: + fixed: false + raw: cloningInfo + realPath: + - cloningInfo + serializedName: cloningInfo + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If specified during app creation, the app is created from a previous + snapshot. + extensions: + x-ms-mutability: + - create + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_124 + name: + fixed: false + raw: snapshotInfo + realPath: + - snapshotInfo + serializedName: snapshotInfo + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group the app belongs to. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroup + realPath: + - resourceGroup + serializedName: resourceGroup + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + true if the app is a default container; otherwise, + false. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isDefaultContainer + realPath: + - isDefaultContainer + serializedName: isDefaultContainer + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Default hostname of the app. Read-only. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: defaultHostName + realPath: + - defaultHostName + serializedName: defaultHostName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Status of the last deployment slot swap operation. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_125 + name: + fixed: false + raw: slotSwapStatus + realPath: + - slotSwapStatus + serializedName: slotSwapStatus + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + HttpsOnly: configures a web site to accept only https requests. + Issues redirect for + + http requests + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: httpsOnly + realPath: + - httpsOnly + serializedName: httpsOnly + serializedName: Site_properties + - &ref_167 + $type: CompositeType + baseModelType: *ref_152 + containsConstantProperties: false + documentation: 'A web app, a mobile app backend, or an API app.' + name: + fixed: false + raw: Site + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_153 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_154 + name: + fixed: false + raw: identity + realPath: + - identity + serializedName: identity + serializedName: Site + - &ref_156 + $type: CompositeType + containsConstantProperties: false + documentation: Describes the capabilities/features allowed for a specific SKU. + name: + fixed: false + raw: Capability + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the SKU capability. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value of the SKU capability. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Reason of the SKU capability. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: reason + realPath: + - reason + serializedName: reason + serializedName: Capability + - &ref_155 + $type: CompositeType + containsConstantProperties: false + documentation: Description of the App Service plan scale options. + name: + fixed: false + raw: SkuCapacity + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Minimum number of workers for this App Service plan SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: minimum + realPath: + - minimum + serializedName: minimum + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Maximum number of workers for this App Service plan SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maximum + realPath: + - maximum + serializedName: maximum + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Default number of workers for this App Service plan SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: default + realPath: + - default + serializedName: default + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Available scale configurations for an App Service plan. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: scaleType + realPath: + - scaleType + serializedName: scaleType + serializedName: SkuCapacity + - &ref_160 + $type: CompositeType + containsConstantProperties: false + documentation: Description of a SKU for a scalable resource. + name: + fixed: false + raw: SkuDescription + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Service tier of the resource SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tier + realPath: + - tier + serializedName: tier + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Size specifier of the resource SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: size + realPath: + - size + serializedName: size + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Family code of the resource SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: family + realPath: + - family + serializedName: family + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Current number of instances assigned to the resource. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: capacity + realPath: + - capacity + serializedName: capacity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Min, max, and default scale values of the SKU.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_155 + name: + fixed: false + raw: skuCapacity + realPath: + - skuCapacity + serializedName: skuCapacity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Locations of the SKU. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: locations + realPath: + - locations + serializedName: locations + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Capabilities of the SKU, e.g., is traffic manager enabled?' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_156 + name: + fixed: false + name: + fixed: false + raw: capabilities + realPath: + - capabilities + serializedName: capabilities + serializedName: SkuDescription + - &ref_159 + $type: CompositeType + containsConstantProperties: false + documentation: AppServicePlan resource specific properties + extensions: + x-ms-client-flatten: true + name: + fixed: false + raw: AppServicePlan_properties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name for the App Service plan. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Target worker tier assigned to the App Service plan. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: workerTierName + realPath: + - workerTierName + serializedName: workerTierName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App Service plan status. + extensions: + x-ms-enum: + modelAsString: false + name: StatusOptions + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_157 + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App Service plan subscription. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscription + realPath: + - subscription + serializedName: subscription + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: App Service plan administration site. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: adminSiteName + realPath: + - adminSiteName + serializedName: adminSiteName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specification for the App Service Environment to use for the App + Service plan. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_122 + name: + fixed: false + raw: hostingEnvironmentProfile + realPath: + - hostingEnvironmentProfile + serializedName: hostingEnvironmentProfile + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Maximum number of instances that can be assigned to this App Service + plan. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maximumNumberOfWorkers + realPath: + - maximumNumberOfWorkers + serializedName: maximumNumberOfWorkers + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Geographical location for the App Service plan. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: geoRegion + realPath: + - geoRegion + serializedName: geoRegion + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: >- + If true, apps assigned to this App Service plan can be + scaled independently. + + If false, apps assigned to this App Service plan will + scale to all instances of the plan. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: perSiteScaling + realPath: + - perSiteScaling + serializedName: perSiteScaling + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Number of apps assigned to this App Service plan. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: numberOfSites + realPath: + - numberOfSites + serializedName: numberOfSites + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If true, this App Service Plan owns spot instances.' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: isSpot + realPath: + - isSpot + serializedName: isSpot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The time when the server farm expires. Valid only if it is a spot + server farm. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: spotExpirationTime + realPath: + - spotExpirationTime + serializedName: spotExpirationTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource group of the App Service plan. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroup + realPath: + - resourceGroup + serializedName: resourceGroup + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: Reserved. + extensions: + x-ms-mutability: + - create + - read + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: reserved + realPath: + - reserved + serializedName: reserved + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Scaling worker count. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetWorkerCount + realPath: + - targetWorkerCount + serializedName: targetWorkerCount + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Scaling worker size ID. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: targetWorkerSizeId + realPath: + - targetWorkerSizeId + serializedName: targetWorkerSizeId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Provisioning state of the App Service Environment. + extensions: + x-ms-enum: + modelAsString: false + name: ProvisioningState + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_158 + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + serializedName: AppServicePlan_properties + - $type: CompositeType + baseModelType: *ref_152 + containsConstantProperties: false + documentation: App Service plan. + name: + fixed: false + raw: AppServicePlan + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: AppServicePlan resource specific properties + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_159 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_160 + name: + fixed: false + raw: sku + realPath: + - sku + serializedName: sku + serializedName: AppServicePlan + - *ref_152 + - &ref_161 + $type: CompositeType + containsConstantProperties: false + documentation: Localizable string object containing the name and a localized value. + name: + fixed: false + raw: LocalizableString + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Non-localized name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Localized name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localizedValue + realPath: + - localizedValue + serializedName: localizedValue + serializedName: LocalizableString + - &ref_162 + $type: CompositeType + containsConstantProperties: false + documentation: Usage of the quota resource. + name: + fixed: false + raw: CsmUsageQuota + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Units of measurement for the quota resourse. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: unit + realPath: + - unit + serializedName: unit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Next reset time for the resource counter. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: nextResetTime + realPath: + - nextResetTime + serializedName: nextResetTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The current value of the resource counter. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: currentValue + realPath: + - currentValue + serializedName: currentValue + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The resource limit. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: limit + realPath: + - limit + serializedName: limit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Quota name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_161 + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: CsmUsageQuota + - &ref_237 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of CSM usage quotas. + name: + fixed: false + raw: CsmUsageQuotaCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_162 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: CsmUsageQuotaCollection + - &ref_163 + $type: CompositeType + containsConstantProperties: false + documentation: Resource metric property. + name: + fixed: false + raw: ResourceMetricProperty + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Key for resource metric property. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: key + realPath: + - key + serializedName: key + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value of pair. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: ResourceMetricProperty + - &ref_164 + $type: CompositeType + containsConstantProperties: false + documentation: Value of resource metric. + name: + fixed: false + raw: ResourceMetricValue + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value timestamp. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timestamp + realPath: + - timestamp + serializedName: timestamp + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value average. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: average + realPath: + - average + serializedName: average + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value minimum. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: minimum + realPath: + - minimum + serializedName: minimum + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value maximum. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: maximum + realPath: + - maximum + serializedName: maximum + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value total. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: total + realPath: + - total + serializedName: total + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Value count. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: float + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: count + realPath: + - count + serializedName: count + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Properties. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_163 + name: + fixed: false + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: ResourceMetricValue + - &ref_165 + $type: CompositeType + containsConstantProperties: false + documentation: Object representing a metric for any resource . + name: + fixed: false + raw: ResourceMetric + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of metric. + isConstant: false + isReadOnly: true + isRequired: false + modelType: *ref_148 + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Metric unit. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: unit + realPath: + - unit + serializedName: unit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Metric granularity. E.g PT1H, PT5M, P1D' + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: timeGrain + realPath: + - timeGrain + serializedName: timeGrain + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Metric start time. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: startTime + realPath: + - startTime + serializedName: startTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Metric end time. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: endTime + realPath: + - endTime + serializedName: endTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Metric resource Id. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceId + realPath: + - resourceId + serializedName: resourceId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Metric values. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_164 + name: + fixed: false + name: + fixed: false + raw: metricValues + realPath: + - metricValues + serializedName: metricValues + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Properties. + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_163 + name: + fixed: false + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: ResourceMetric + - &ref_207 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of metric responses. + name: + fixed: false + raw: ResourceMetricCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_165 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ResourceMetricCollection + - &ref_206 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of metric definitions. + name: + fixed: false + raw: ResourceMetricDefinitionCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_166 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: ResourceMetricDefinitionCollection + - &ref_168 + $type: CompositeType + containsConstantProperties: false + documentation: Collection of App Service apps. + name: + fixed: false + raw: WebAppCollection + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Collection of resources. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: SequenceType + elementType: *ref_167 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Link to next page of resources. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: WebAppCollection + - &ref_211 + $type: CompositeType + containsConstantProperties: false + documentation: Operation. + name: + fixed: false + raw: Operation + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Operation ID. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Operation name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The current status of the operation. + extensions: + x-ms-enum: + modelAsString: false + name: OperationStatus + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_47 + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Any errors associate with the operation. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_21 + name: + fixed: false + name: + fixed: false + raw: errors + realPath: + - errors + serializedName: errors + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time when operation has started. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: createdTime + realPath: + - createdTime + serializedName: createdTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time when operation has been updated. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: modifiedTime + realPath: + - modifiedTime + serializedName: modifiedTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time when operation will expire. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: expirationTime + realPath: + - expirationTime + serializedName: expirationTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Applicable only for stamp operation ids. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: uuid + knownPrimaryType: uuid + name: + fixed: false + raw: Uuid + name: + fixed: false + raw: geoMasterOperationId + realPath: + - geoMasterOperationId + serializedName: geoMasterOperationId + serializedName: Operation +modelsName: Models +name: WebAppsAPIClient +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Get all apps for a subscription. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: &ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: &ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_168 + isNullable: true + returnType: + body: *ref_168 + isNullable: true + serializedName: WebApps_List + summary: Get all apps for a subscription. + url: '/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites' + - defaultResponse: + isNullable: true + deprecated: false + description: 'Gets all web, mobile, and API apps in the specified resource group.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListByResourceGroup + parameters: + - clientProperty: &ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + realPath: + - resourceGroupName + serializedName: resourceGroupName + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specify true to include deployment slots in + results. The default is false, which only gives you the + production slot of all apps. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: includeSlots + serializedName: includeSlots + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_168 + isNullable: true + returnType: + body: *ref_168 + isNullable: true + serializedName: WebApps_ListByResourceGroup + summary: 'Gets all web, mobile, and API apps in the specified resource group.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites + - defaultResponse: + isNullable: true + deprecated: false + description: 'Gets the details of a web, mobile, or API app.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: Get + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_167 + isNullable: true + returnType: + body: *ref_167 + isNullable: true + serializedName: WebApps_Get + summary: 'Gets the details of a web, mobile, or API app.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a new web, mobile, or API app in an existing resource group, + or updates an existing app. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdate + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unique name of the app to create or update. To create or update + a deployment slot, use the {slot} parameter. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the app properties. See example. + extensions: + x-ms-requestBody-name: siteEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_167 + name: + fixed: false + raw: siteEnvelope + serializedName: siteEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true web app hostname is not registered with DNS on creation. + This parameter is + only used for app creation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipDnsRegistration + serializedName: skipDnsRegistration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true, custom (non *.azurewebsites.net) domains associated + with web app are not verified. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipCustomDomainVerification + serializedName: skipCustomDomainVerification + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If true, web app hostname is force registered with DNS.' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: forceDnsRegistration + serializedName: forceDnsRegistration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time to live in seconds for web app's default domain name. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ttlInSeconds + serializedName: ttlInSeconds + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_167 + isNullable: true + OK: + body: *ref_167 + isNullable: true + returnType: + body: *ref_167 + isNullable: true + serializedName: WebApps_CreateOrUpdate + summary: >- + Creates a new web, mobile, or API app in an existing resource group, + or updates an existing app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Deletes a web, mobile, or API app, or one of the deployment slots.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If true, web app metrics are also deleted.' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: deleteMetrics + serializedName: deleteMetrics + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specify true if the App Service plan will be empty after app + deletion and you want to delete the empty App Service plan. By + default, the empty App Service plan is not deleted. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: deleteEmptyServerFarm + serializedName: deleteEmptyServerFarm + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If true, DNS registration is skipped.' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipDnsRegistration + serializedName: skipDnsRegistration + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_Delete + summary: 'Deletes a web, mobile, or API app, or one of the deployment slots.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a new web, mobile, or API app in an existing resource group, + or updates an existing app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: Update + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unique name of the app to create or update. To create or update + a deployment slot, use the {slot} parameter. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the app properties. See example. + extensions: + x-ms-requestBody-name: siteEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_172 + name: + fixed: false + raw: siteEnvelope + serializedName: siteEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true web app hostname is not registered with DNS on creation. + This parameter is + only used for app creation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipDnsRegistration + serializedName: skipDnsRegistration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true, custom (non *.azurewebsites.net) domains associated + with web app are not verified. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipCustomDomainVerification + serializedName: skipCustomDomainVerification + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If true, web app hostname is force registered with DNS.' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: forceDnsRegistration + serializedName: forceDnsRegistration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time to live in seconds for web app's default domain name. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ttlInSeconds + serializedName: ttlInSeconds + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_167 + isNullable: true + OK: + body: *ref_167 + isNullable: true + returnType: + body: *ref_167 + isNullable: true + serializedName: WebApps_Update + summary: >- + Creates a new web, mobile, or API app in an existing resource group, + or updates an existing app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name} + - defaultResponse: + isNullable: true + deprecated: false + description: Analyze a custom hostname. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: AnalyzeCustomHostname + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Custom hostname. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostName + serializedName: hostName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_173 + isNullable: true + returnType: + body: *ref_173 + isNullable: true + serializedName: WebApps_AnalyzeCustomHostname + summary: Analyze a custom hostname. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Applies the configuration settings from the target slot onto the + current slot. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ApplySlotConfigToProduction + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON object that contains the target slot name. See example. + extensions: + x-ms-requestBody-name: slotSwapEntity + isConstant: false + isRequired: true + location: body + modelType: *ref_174 + name: + fixed: false + raw: slotSwapEntity + serializedName: slotSwapEntity + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_ApplySlotConfigToProduction + summary: >- + Applies the configuration settings from the target slot onto the + current slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a backup of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Backup + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Backup configuration. You can use the JSON response from the + POST action as input here. + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_175 + name: + fixed: false + raw: request + serializedName: request + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: WebApps_Backup + summary: Creates a backup of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup + - defaultResponse: + isNullable: true + deprecated: false + description: Gets existing backups of an app. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListBackups + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_176 + isNullable: true + returnType: + body: *ref_176 + isNullable: true + serializedName: WebApps_ListBackups + summary: Gets existing backups of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Discovers an existing app backup that can be restored from a blob in + Azure storage. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: DiscoverRestore + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A RestoreRequest object that includes Azure storage URL and blog + name for discovery of backup. + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_177 + name: + fixed: false + raw: request + serializedName: request + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_177 + isNullable: true + returnType: + body: *ref_177 + isNullable: true + serializedName: WebApps_DiscoverRestore + summary: >- + Discovers an existing app backup that can be restored from a blob in + Azure storage. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a backup of an app by its ID. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetBackupStatus + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of the backup. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: backupId + serializedName: backupId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: WebApps_GetBackupStatus + summary: Gets a backup of an app by its ID. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a backup of an app by its ID. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteBackup + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of the backup. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: backupId + serializedName: backupId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteBackup + summary: Deletes a backup of an app by its ID. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets status of a web app backup that may be in progress, including + secrets associated with the backup, such as the Azure Storage SAS URL. + Also can be used to update the SAS URL for the backup if a new URL is + passed in the request body. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListBackupStatusSecrets + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of backup. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: backupId + serializedName: backupId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Information on backup request. + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_175 + name: + fixed: false + raw: request + serializedName: request + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: WebApps_ListBackupStatusSecrets + summary: >- + Gets status of a web app backup that may be in progress, including + secrets associated with the backup, such as the Azure Storage SAS URL. + Also can be used to update the SAS URL for the backup if a new URL is + passed in the request body. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Restores a specific backup to another app (or deployment slot, if + specified). + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Restore + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of the backup. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: backupId + serializedName: backupId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Information on restore request . + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_177 + name: + fixed: false + raw: request + serializedName: request + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_178 + isNullable: true + returnType: + body: *ref_178 + isNullable: true + serializedName: WebApps_Restore + summary: >- + Restores a specific backup to another app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore + - defaultResponse: + isNullable: true + deprecated: false + description: List the configurations of an app + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListConfigurations + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_179 + isNullable: true + returnType: + body: *ref_179 + isNullable: true + serializedName: WebApps_ListConfigurations + summary: List the configurations of an app + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config + - defaultResponse: + isNullable: true + deprecated: false + description: Replaces the application settings of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateApplicationSettings + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application settings of the app. + extensions: + x-ms-requestBody-name: appSettings + isConstant: false + isRequired: true + location: body + modelType: *ref_180 + name: + fixed: false + raw: appSettings + serializedName: appSettings + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_180 + isNullable: true + returnType: + body: *ref_180 + isNullable: true + serializedName: WebApps_UpdateApplicationSettings + summary: Replaces the application settings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the application settings of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListApplicationSettings + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_180 + isNullable: true + returnType: + body: *ref_180 + isNullable: true + serializedName: WebApps_ListApplicationSettings + summary: Gets the application settings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Updates the Authentication / Authorization settings associated with + web app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateAuthSettings + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Auth settings associated with web app. + extensions: + x-ms-requestBody-name: siteAuthSettings + isConstant: false + isRequired: true + location: body + modelType: *ref_181 + name: + fixed: false + raw: siteAuthSettings + serializedName: siteAuthSettings + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_181 + isNullable: true + returnType: + body: *ref_181 + isNullable: true + serializedName: WebApps_UpdateAuthSettings + summary: >- + Updates the Authentication / Authorization settings associated with + web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the Authentication/Authorization settings of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GetAuthSettings + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_181 + isNullable: true + returnType: + body: *ref_181 + isNullable: true + serializedName: WebApps_GetAuthSettings + summary: Gets the Authentication/Authorization settings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the backup configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateBackupConfiguration + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Edited backup configuration. + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_175 + name: + fixed: false + raw: request + serializedName: request + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_175 + isNullable: true + returnType: + body: *ref_175 + isNullable: true + serializedName: WebApps_UpdateBackupConfiguration + summary: Updates the backup configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes the backup configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteBackupConfiguration + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteBackupConfiguration + summary: Deletes the backup configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the backup configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GetBackupConfiguration + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_175 + isNullable: true + returnType: + body: *ref_175 + isNullable: true + serializedName: WebApps_GetBackupConfiguration + summary: Gets the backup configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list + - defaultResponse: + isNullable: true + deprecated: false + description: Replaces the connection strings of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateConnectionStrings + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Connection strings of the app or deployment slot. See example. + extensions: + x-ms-requestBody-name: connectionStrings + isConstant: false + isRequired: true + location: body + modelType: *ref_182 + name: + fixed: false + raw: connectionStrings + serializedName: connectionStrings + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_182 + isNullable: true + returnType: + body: *ref_182 + isNullable: true + serializedName: WebApps_UpdateConnectionStrings + summary: Replaces the connection strings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the connection strings of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListConnectionStrings + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_182 + isNullable: true + returnType: + body: *ref_182 + isNullable: true + serializedName: WebApps_ListConnectionStrings + summary: Gets the connection strings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the logging configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetDiagnosticLogsConfiguration + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_183 + isNullable: true + returnType: + body: *ref_183 + isNullable: true + serializedName: WebApps_GetDiagnosticLogsConfiguration + summary: Gets the logging configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the logging configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateDiagnosticLogsConfig + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A SiteLogsConfig JSON object that contains the logging + configuration to change in the "properties" property. + extensions: + x-ms-requestBody-name: siteLogsConfig + isConstant: false + isRequired: true + location: body + modelType: *ref_183 + name: + fixed: false + raw: siteLogsConfig + serializedName: siteLogsConfig + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_183 + isNullable: true + returnType: + body: *ref_183 + isNullable: true + serializedName: WebApps_UpdateDiagnosticLogsConfig + summary: Updates the logging configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs + - defaultResponse: + isNullable: true + deprecated: false + description: Replaces the metadata of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateMetadata + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Edited metadata of the app or deployment slot. See example. + extensions: + x-ms-requestBody-name: metadata + isConstant: false + isRequired: true + location: body + modelType: *ref_180 + name: + fixed: false + raw: metadata + serializedName: metadata + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_180 + isNullable: true + returnType: + body: *ref_180 + isNullable: true + serializedName: WebApps_UpdateMetadata + summary: Replaces the metadata of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the metadata of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListMetadata + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_180 + isNullable: true + returnType: + body: *ref_180 + isNullable: true + serializedName: WebApps_ListMetadata + summary: Gets the metadata of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the Git/FTP publishing credentials of an app. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListPublishingCredentials + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_184 + isNullable: true + returnType: + body: *ref_184 + isNullable: true + serializedName: WebApps_ListPublishingCredentials + summary: Gets the Git/FTP publishing credentials of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the Push settings associated with web app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateSitePushSettings + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Push settings associated with web app. + extensions: + x-ms-requestBody-name: pushSettings + isConstant: false + isRequired: true + location: body + modelType: *ref_101 + name: + fixed: false + raw: pushSettings + serializedName: pushSettings + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_101 + isNullable: true + returnType: + body: *ref_101 + isNullable: true + serializedName: WebApps_UpdateSitePushSettings + summary: Updates the Push settings associated with web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the Push settings associated with web app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListSitePushSettings + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_101 + isNullable: true + returnType: + body: *ref_101 + isNullable: true + serializedName: WebApps_ListSitePushSettings + summary: Gets the Push settings associated with web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the names of app settings and connection strings that stick to + the slot (not swapped). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListSlotConfigurationNames + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_185 + isNullable: true + returnType: + body: *ref_185 + isNullable: true + serializedName: WebApps_ListSlotConfigurationNames + summary: >- + Gets the names of app settings and connection strings that stick to + the slot (not swapped). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Updates the names of application settings and connection string that + remain with the slot during swap operation. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateSlotConfigurationNames + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Names of application settings and connection strings. See + example. + extensions: + x-ms-requestBody-name: slotConfigNames + isConstant: false + isRequired: true + location: body + modelType: *ref_185 + name: + fixed: false + raw: slotConfigNames + serializedName: slotConfigNames + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_185 + isNullable: true + returnType: + body: *ref_185 + isNullable: true + serializedName: WebApps_UpdateSlotConfigurationNames + summary: >- + Updates the names of application settings and connection string that + remain with the slot during swap operation. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the configuration of an app, such as platform version and + bitness, default documents, virtual applications, Always On, etc. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetConfiguration + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_105 + isNullable: true + returnType: + body: *ref_105 + isNullable: true + serializedName: WebApps_GetConfiguration + summary: >- + Gets the configuration of an app, such as platform version and + bitness, default documents, virtual applications, Always On, etc. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateConfiguration + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON representation of a SiteConfig object. See example. + extensions: + x-ms-requestBody-name: siteConfig + isConstant: false + isRequired: true + location: body + modelType: *ref_105 + name: + fixed: false + raw: siteConfig + serializedName: siteConfig + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_105 + isNullable: true + returnType: + body: *ref_105 + isNullable: true + serializedName: WebApps_CreateOrUpdateConfiguration + summary: Updates the configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateConfiguration + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON representation of a SiteConfig object. See example. + extensions: + x-ms-requestBody-name: siteConfig + isConstant: false + isRequired: true + location: body + modelType: *ref_105 + name: + fixed: false + raw: siteConfig + serializedName: siteConfig + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_105 + isNullable: true + returnType: + body: *ref_105 + isNullable: true + serializedName: WebApps_UpdateConfiguration + summary: Updates the configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a list of web app configuration snapshots identifiers. Each + element of the list contains a timestamp and the ID of the snapshot. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListConfigurationSnapshotInfo + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_186 + isNullable: true + returnType: + body: *ref_186 + isNullable: true + serializedName: WebApps_ListConfigurationSnapshotInfo + summary: >- + Gets a list of web app configuration snapshots identifiers. Each + element of the list contains a timestamp and the ID of the snapshot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a snapshot of the configuration of an app at a previous point in + time. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetConfigurationSnapshot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the snapshot to read. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: snapshotId + serializedName: snapshotId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_105 + isNullable: true + returnType: + body: *ref_105 + isNullable: true + serializedName: WebApps_GetConfigurationSnapshot + summary: >- + Gets a snapshot of the configuration of an app at a previous point in + time. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId} + - defaultResponse: + isNullable: true + deprecated: false + description: Reverts the configuration of an app to a previous snapshot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: RecoverSiteConfigurationSnapshot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the snapshot to read. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: snapshotId + serializedName: snapshotId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_RecoverSiteConfigurationSnapshot + summary: Reverts the configuration of an app to a previous snapshot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the last lines of docker logs for the given site + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GetWebSiteContainerLogs + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: &ref_187 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_187 + isNullable: true + serializedName: WebApps_GetWebSiteContainerLogs + summary: Gets the last lines of docker logs for the given site + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the ZIP archived docker log files for the given site + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GetContainerLogsZip + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: &ref_188 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_188 + isNullable: true + serializedName: WebApps_GetContainerLogsZip + summary: Gets the ZIP archived docker log files for the given site + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download + - defaultResponse: + isNullable: true + deprecated: false + description: 'List continuous web jobs for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListContinuousWebJobs + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_189 + isNullable: true + returnType: + body: *ref_189 + isNullable: true + serializedName: WebApps_ListContinuousWebJobs + summary: 'List continuous web jobs for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs + - defaultResponse: + isNullable: true + deprecated: false + description: 'Gets a continuous web job by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetContinuousWebJob + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_19 + isNullable: true + returnType: + body: *ref_19 + isNullable: true + serializedName: WebApps_GetContinuousWebJob + summary: 'Gets a continuous web job by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Delete a continuous web job by its ID for an app, or a deployment + slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteContinuousWebJob + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteContinuousWebJob + summary: >- + Delete a continuous web job by its ID for an app, or a deployment + slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Start a continuous web job for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StartContinuousWebJob + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_StartContinuousWebJob + summary: 'Start a continuous web job for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start + - defaultResponse: + isNullable: true + deprecated: false + description: 'Stop a continuous web job for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StopContinuousWebJob + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_StopContinuousWebJob + summary: 'Stop a continuous web job for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop + - defaultResponse: + isNullable: true + deprecated: false + description: 'List deployments for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListDeployments + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_190 + isNullable: true + returnType: + body: *ref_190 + isNullable: true + serializedName: WebApps_ListDeployments + summary: 'List deployments for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments + - defaultResponse: + isNullable: true + deprecated: false + description: 'Get a deployment by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetDeployment + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Deployment ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_25 + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: WebApps_GetDeployment + summary: 'Get a deployment by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Create a deployment for an app, or a deployment slot.' + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateDeployment + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of an existing deployment. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Deployment details. + extensions: + x-ms-requestBody-name: deployment + isConstant: false + isRequired: true + location: body + modelType: *ref_25 + name: + fixed: false + raw: deployment + serializedName: deployment + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_25 + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: WebApps_CreateDeployment + summary: 'Create a deployment for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Delete a deployment by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteDeployment + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Deployment ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteDeployment + summary: 'Delete a deployment by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List deployment log for specific deployment for an app, or a + deployment slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListDeploymentLog + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of a specific deployment. This is the value of the name + property in the JSON response from "GET + /api/sites/{siteName}/deployments". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_25 + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: WebApps_ListDeploymentLog + summary: >- + List deployment log for specific deployment for an app, or a + deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log + - defaultResponse: + isNullable: true + deprecated: false + description: Lists ownership identifiers for domain associated with web app. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListDomainOwnershipIdentifiers + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_191 + isNullable: true + returnType: + body: *ref_191 + isNullable: true + serializedName: WebApps_ListDomainOwnershipIdentifiers + summary: Lists ownership identifiers for domain associated with web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers + - defaultResponse: + isNullable: true + deprecated: false + description: Get domain ownership identifier for web app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetDomainOwnershipIdentifier + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of domain ownership identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainOwnershipIdentifierName + serializedName: domainOwnershipIdentifierName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_38 + isNullable: true + returnType: + body: *ref_38 + isNullable: true + serializedName: WebApps_GetDomainOwnershipIdentifier + summary: Get domain ownership identifier for web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a domain ownership identifier for web app, or updates an + existing ownership identifier. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateDomainOwnershipIdentifier + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of domain ownership identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainOwnershipIdentifierName + serializedName: domainOwnershipIdentifierName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the domain ownership properties. + extensions: + x-ms-requestBody-name: domainOwnershipIdentifier + isConstant: false + isRequired: true + location: body + modelType: *ref_38 + name: + fixed: false + raw: domainOwnershipIdentifier + serializedName: domainOwnershipIdentifier + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_38 + isNullable: true + returnType: + body: *ref_38 + isNullable: true + serializedName: WebApps_CreateOrUpdateDomainOwnershipIdentifier + summary: >- + Creates a domain ownership identifier for web app, or updates an + existing ownership identifier. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a domain ownership identifier for a web app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteDomainOwnershipIdentifier + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of domain ownership identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainOwnershipIdentifierName + serializedName: domainOwnershipIdentifierName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteDomainOwnershipIdentifier + summary: Deletes a domain ownership identifier for a web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a domain ownership identifier for web app, or updates an + existing ownership identifier. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateDomainOwnershipIdentifier + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of domain ownership identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainOwnershipIdentifierName + serializedName: domainOwnershipIdentifierName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the domain ownership properties. + extensions: + x-ms-requestBody-name: domainOwnershipIdentifier + isConstant: false + isRequired: true + location: body + modelType: *ref_38 + name: + fixed: false + raw: domainOwnershipIdentifier + serializedName: domainOwnershipIdentifier + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_38 + isNullable: true + returnType: + body: *ref_38 + isNullable: true + serializedName: WebApps_UpdateDomainOwnershipIdentifier + summary: >- + Creates a domain ownership identifier for web app, or updates an + existing ownership identifier. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} + - defaultResponse: + isNullable: true + deprecated: false + description: Get the status of the last MSDeploy operation. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetMSDeployStatus + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_192 + isNullable: true + returnType: + body: *ref_192 + isNullable: true + serializedName: WebApps_GetMSDeployStatus + summary: Get the status of the last MSDeploy operation. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy + - defaultResponse: + isNullable: true + deprecated: false + description: Invoke the MSDeploy web app extension. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateMSDeployOperation + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details of MSDeploy operation + extensions: + x-ms-requestBody-name: MSDeploy + isConstant: false + isRequired: true + location: body + modelType: *ref_193 + name: + fixed: false + raw: MSDeploy + serializedName: MSDeploy + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Conflict: + isNullable: true + Created: + body: *ref_192 + isNullable: true + returnType: + body: *ref_192 + isNullable: true + serializedName: WebApps_CreateMSDeployOperation + summary: Invoke the MSDeploy web app extension. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy + - defaultResponse: + isNullable: true + deprecated: false + description: Get the MSDeploy Log for the last MSDeploy operation. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetMSDeployLog + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_194 + isNullable: true + returnType: + body: *ref_194 + isNullable: true + serializedName: WebApps_GetMSDeployLog + summary: Get the MSDeploy Log for the last MSDeploy operation. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log + - defaultResponse: + isNullable: true + deprecated: false + description: 'List the functions for a web site, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListFunctions + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_195 + isNullable: true + returnType: + body: *ref_195 + isNullable: true + serializedName: WebApps_ListFunctions + summary: 'List the functions for a web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions + - defaultResponse: + isNullable: true + deprecated: false + description: Fetch a short lived token that can be exchanged for a master key. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetFunctionsAdminToken + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_196 + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_196 + isNullable: true + serializedName: WebApps_GetFunctionsAdminToken + summary: Fetch a short lived token that can be exchanged for a master key. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token + - defaultResponse: + isNullable: true + deprecated: false + description: 'Get function information by its ID for web site, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetFunction + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: functionName + serializedName: functionName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: WebApps_GetFunction + summary: 'Get function information by its ID for web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Create function for web site, or a deployment slot.' + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateFunction + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: functionName + serializedName: functionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function details. + extensions: + x-ms-requestBody-name: function_envelope + isConstant: false + isRequired: true + location: body + modelType: *ref_27 + name: + fixed: false + raw: function_envelope + serializedName: function_envelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: WebApps_CreateFunction + summary: 'Create function for web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Delete a function for web site, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteFunction + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: functionName + serializedName: functionName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteFunction + summary: 'Delete a function for web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get function secrets for a function in a web site, or a deployment + slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListFunctionSecrets + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: functionName + serializedName: functionName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_197 + isNullable: true + returnType: + body: *ref_197 + isNullable: true + serializedName: WebApps_ListFunctionSecrets + summary: >- + Get function secrets for a function in a web site, or a deployment + slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets + - defaultResponse: + isNullable: true + deprecated: false + description: Get hostname bindings for an app or a deployment slot. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListHostNameBindings + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_198 + isNullable: true + returnType: + body: *ref_198 + isNullable: true + serializedName: WebApps_ListHostNameBindings + summary: Get hostname bindings for an app or a deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get the named hostname binding for an app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetHostNameBinding + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostname in the hostname binding. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostName + serializedName: hostName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_34 + isNullable: true + returnType: + body: *ref_34 + isNullable: true + serializedName: WebApps_GetHostNameBinding + summary: >- + Get the named hostname binding for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName} + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a hostname binding for an app. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateHostNameBinding + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostname in the hostname binding. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostName + serializedName: hostName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Binding details. This is the JSON representation of a + HostNameBinding object. + extensions: + x-ms-requestBody-name: hostNameBinding + isConstant: false + isRequired: true + location: body + modelType: *ref_34 + name: + fixed: false + raw: hostNameBinding + serializedName: hostNameBinding + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_34 + isNullable: true + returnType: + body: *ref_34 + isNullable: true + serializedName: WebApps_CreateOrUpdateHostNameBinding + summary: Creates a hostname binding for an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a hostname binding for an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteHostNameBinding + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostname in the hostname binding. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostName + serializedName: hostName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteHostNameBinding + summary: Deletes a hostname binding for an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Retrieves a specific Service Bus Hybrid Connection used by this Web + App. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetHybridConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_57 + isNullable: true + returnType: + body: *ref_57 + isNullable: true + serializedName: WebApps_GetHybridConnection + summary: >- + Retrieves a specific Service Bus Hybrid Connection used by this Web + App. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a new Hybrid Connection using a Service Bus relay. + extensions: + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateHybridConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The details of the hybrid connection. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_57 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_57 + isNullable: true + returnType: + body: *ref_57 + isNullable: true + serializedName: WebApps_CreateOrUpdateHybridConnection + summary: Creates a new Hybrid Connection using a Service Bus relay. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} + - defaultResponse: + isNullable: true + deprecated: false + description: Removes a Hybrid Connection from this site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteHybridConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteHybridConnection + summary: Removes a Hybrid Connection from this site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a new Hybrid Connection using a Service Bus relay. + extensions: + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateHybridConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The details of the hybrid connection. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_57 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_57 + isNullable: true + returnType: + body: *ref_57 + isNullable: true + serializedName: WebApps_UpdateHybridConnection + summary: Creates a new Hybrid Connection using a Service Bus relay. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the send key name and value for a Hybrid Connection. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListHybridConnectionKeys + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_199 + isNullable: true + returnType: + body: *ref_199 + isNullable: true + serializedName: WebApps_ListHybridConnectionKeys + summary: Gets the send key name and value for a Hybrid Connection. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys + - defaultResponse: + isNullable: true + deprecated: false + description: Retrieves all Service Bus Hybrid Connections used by this Web App. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListHybridConnections + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_57 + isNullable: true + returnType: + body: *ref_57 + isNullable: true + serializedName: WebApps_ListHybridConnections + summary: Retrieves all Service Bus Hybrid Connections used by this Web App. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets hybrid connections configured for an app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListRelayServiceConnections + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_56 + isNullable: true + returnType: + body: *ref_56 + isNullable: true + serializedName: WebApps_ListRelayServiceConnections + summary: >- + Gets hybrid connections configured for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a hybrid connection configuration by its name. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetRelayServiceConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityName + serializedName: entityName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_56 + isNullable: true + returnType: + body: *ref_56 + isNullable: true + serializedName: WebApps_GetRelayServiceConnection + summary: Gets a hybrid connection configuration by its name. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a new hybrid connection configuration (PUT), or updates an + existing one (PATCH). + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateRelayServiceConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the hybrid connection configuration. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityName + serializedName: entityName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details of the hybrid connection configuration. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_56 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_56 + isNullable: true + returnType: + body: *ref_56 + isNullable: true + serializedName: WebApps_CreateOrUpdateRelayServiceConnection + summary: >- + Creates a new hybrid connection configuration (PUT), or updates an + existing one (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a relay service connection by its name. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteRelayServiceConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the hybrid connection configuration. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityName + serializedName: entityName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteRelayServiceConnection + summary: Deletes a relay service connection by its name. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a new hybrid connection configuration (PUT), or updates an + existing one (PATCH). + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateRelayServiceConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the hybrid connection configuration. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityName + serializedName: entityName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details of the hybrid connection configuration. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_56 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_56 + isNullable: true + returnType: + body: *ref_56 + isNullable: true + serializedName: WebApps_UpdateRelayServiceConnection + summary: >- + Creates a new hybrid connection configuration (PUT), or updates an + existing one (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets all scale-out instances of an app. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListInstanceIdentifiers + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_200 + isNullable: true + returnType: + body: *ref_200 + isNullable: true + serializedName: WebApps_ListInstanceIdentifiers + summary: Gets all scale-out instances of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances + - defaultResponse: + isNullable: true + deprecated: false + description: Get the status of the last MSDeploy operation. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceMsDeployStatus + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of web app instance. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_192 + isNullable: true + returnType: + body: *ref_192 + isNullable: true + serializedName: WebApps_GetInstanceMsDeployStatus + summary: Get the status of the last MSDeploy operation. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy + - defaultResponse: + isNullable: true + deprecated: false + description: Invoke the MSDeploy web app extension. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateInstanceMSDeployOperation + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of web app instance. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details of MSDeploy operation + extensions: + x-ms-requestBody-name: MSDeploy + isConstant: false + isRequired: true + location: body + modelType: *ref_193 + name: + fixed: false + raw: MSDeploy + serializedName: MSDeploy + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Conflict: + isNullable: true + Created: + body: *ref_192 + isNullable: true + returnType: + body: *ref_192 + isNullable: true + serializedName: WebApps_CreateInstanceMSDeployOperation + summary: Invoke the MSDeploy web app extension. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy + - defaultResponse: + isNullable: true + deprecated: false + description: Get the MSDeploy Log for the last MSDeploy operation. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceMSDeployLog + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of web app instance. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_194 + isNullable: true + returnType: + body: *ref_194 + isNullable: true + serializedName: WebApps_GetInstanceMSDeployLog + summary: Get the MSDeploy Log for the last MSDeploy operation. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get list of processes for a web site, or a deployment slot, or for a + specific scaled-out instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListInstanceProcesses + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_201 + isNullable: true + returnType: + body: *ref_201 + isNullable: true + serializedName: WebApps_ListInstanceProcesses + summary: >- + Get list of processes for a web site, or a deployment slot, or for a + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceProcess + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_68 + isNullable: true + returnType: + body: *ref_68 + isNullable: true + serializedName: WebApps_GetInstanceProcess + summary: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Terminate a process by its ID for a web site, or a deployment slot, or + specific scaled-out instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteInstanceProcess + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteInstanceProcess + summary: >- + Terminate a process by its ID for a web site, or a deployment slot, or + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get a memory dump of a process by its ID for a specific scaled-out + instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceProcessDump + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: &ref_202 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_202 + isNullable: true + serializedName: WebApps_GetInstanceProcessDump + summary: >- + Get a memory dump of a process by its ID for a specific scaled-out + instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List module information for a process by its ID for a specific + scaled-out instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListInstanceProcessModules + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_203 + isNullable: true + returnType: + body: *ref_203 + isNullable: true + serializedName: WebApps_ListInstanceProcessModules + summary: >- + List module information for a process by its ID for a specific + scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceProcessModule + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Module base address. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: baseAddress + serializedName: baseAddress + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_66 + isNullable: true + returnType: + body: *ref_66 + isNullable: true + serializedName: WebApps_GetInstanceProcessModule + summary: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List the threads in a process by its ID for a specific scaled-out + instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListInstanceProcessThreads + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_204 + isNullable: true + returnType: + body: *ref_204 + isNullable: true + serializedName: WebApps_ListInstanceProcessThreads + summary: >- + List the threads in a process by its ID for a specific scaled-out + instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get thread information by Thread ID for a specific process, in a + specific scaled-out instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceProcessThread + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: TID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: threadId + serializedName: threadId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_65 + isNullable: true + returnType: + body: *ref_65 + isNullable: true + serializedName: WebApps_GetInstanceProcessThread + summary: >- + Get thread information by Thread ID for a specific process, in a + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads/{threadId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Shows whether an app can be cloned to another resource group or + subscription. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: IsCloneable + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_205 + isNullable: true + returnType: + body: *ref_205 + isNullable: true + serializedName: WebApps_IsCloneable + summary: >- + Shows whether an app can be cloned to another resource group or + subscription. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable + - defaultResponse: + isNullable: true + deprecated: false + description: This is to allow calling via powershell and ARM template. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListSyncFunctionTriggers + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_197 + isNullable: true + returnType: + body: *ref_197 + isNullable: true + serializedName: WebApps_ListSyncFunctionTriggers + summary: This is to allow calling via powershell and ARM template. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets all metric definitions of an app (or deployment slot, if + specified). + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListMetricDefinitions + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_206 + isNullable: true + returnType: + body: *ref_206 + isNullable: true + serializedName: WebApps_ListMetricDefinitions + summary: >- + Gets all metric definitions of an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions + - defaultResponse: + isNullable: true + deprecated: false + description: 'Gets performance metrics of an app (or deployment slot, if specified).' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListMetrics + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specify "true" to include metric details in the response. It is + "false" by default. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: details + serializedName: details + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Return only metrics specified in the filter (using OData + syntax). For example: $filter=(name.value eq 'Metric1' or + name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' + and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq + duration'[Hour|Minute|Day]'. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_207 + isNullable: true + returnType: + body: *ref_207 + isNullable: true + serializedName: WebApps_ListMetrics + summary: 'Gets performance metrics of an app (or deployment slot, if specified).' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics + - defaultResponse: + isNullable: true + deprecated: false + description: Restores a web app. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: MigrateStorage + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Azure subscription. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionName + serializedName: subscriptionName + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Migration migrationOptions. + extensions: + x-ms-requestBody-name: migrationOptions + isConstant: false + isRequired: true + location: body + modelType: *ref_208 + name: + fixed: false + raw: migrationOptions + serializedName: migrationOptions + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_209 + isNullable: true + returnType: + body: *ref_209 + isNullable: true + serializedName: WebApps_MigrateStorage + summary: Restores a web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate + - defaultResponse: + isNullable: true + deprecated: false + description: Migrates a local (in-app) MySql database to a remote MySql database. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: MigrateMySql + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: MySql migration options. + extensions: + x-ms-requestBody-name: migrationRequestEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_210 + name: + fixed: false + raw: migrationRequestEnvelope + serializedName: migrationRequestEnvelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_211 + isNullable: true + returnType: + body: *ref_211 + isNullable: true + serializedName: WebApps_MigrateMySql + summary: Migrates a local (in-app) MySql database to a remote MySql database. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Returns the status of MySql in app migration, if one is active, and + whether or not MySql in app is enabled + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetMigrateMySqlStatus + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_212 + isNullable: true + returnType: + body: *ref_212 + isNullable: true + serializedName: WebApps_GetMigrateMySqlStatus + summary: >- + Returns the status of MySql in app migration, if one is active, and + whether or not MySql in app is enabled + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets all network features used by the app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListNetworkFeatures + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The type of view. This can either be "summary" or "detailed". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: view + serializedName: view + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_213 + isNullable: true + returnType: + body: *ref_213 + isNullable: true + serializedName: WebApps_ListNetworkFeatures + summary: >- + Gets all network features used by the app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view} + - defaultResponse: + isNullable: true + deprecated: false + description: Start capturing network packets for the site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StartWebSiteNetworkTrace + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The duration to keep capturing in seconds. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: durationInSeconds + serializedName: durationInSeconds + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The maximum frame length in bytes (Optional). + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxFrameLength + serializedName: maxFrameLength + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Blob URL to store capture file. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sasUrl + serializedName: sasUrl + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_214 + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_214 + isNullable: true + serializedName: WebApps_StartWebSiteNetworkTrace + summary: Start capturing network packets for the site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start + - defaultResponse: + isNullable: true + deprecated: false + description: Stop ongoing capturing network packets for the site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StopWebSiteNetworkTrace + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_215 + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_215 + isNullable: true + serializedName: WebApps_StopWebSiteNetworkTrace + summary: Stop ongoing capturing network packets for the site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Generates a new publishing password for an app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GenerateNewSitePublishingPassword + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_GenerateNewSitePublishingPassword + summary: >- + Generates a new publishing password for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword + - defaultResponse: + isNullable: true + deprecated: false + description: Gets perfmon counters for web app. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListPerfMonCounters + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Return only usages/metrics specified in the filter. Filter + conforms to odata syntax. Example: $filter=(startTime eq + '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and + timeGrain eq duration'[Hour|Minute|Day]'. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_216 + isNullable: true + returnType: + body: *ref_216 + isNullable: true + serializedName: WebApps_ListPerfMonCounters + summary: Gets perfmon counters for web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters + - defaultResponse: + isNullable: true + deprecated: false + description: Gets web app's event logs. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetSitePhpErrorLogFlag + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_217 + isNullable: true + returnType: + body: *ref_217 + isNullable: true + serializedName: WebApps_GetSitePhpErrorLogFlag + summary: Gets web app's event logs. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the premier add-ons of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListPremierAddOns + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_218 + isNullable: true + returnType: + body: *ref_218 + isNullable: true + serializedName: WebApps_ListPremierAddOns + summary: Gets the premier add-ons of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a named add-on of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetPremierAddOn + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Add-on name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: premierAddOnName + serializedName: premierAddOnName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_218 + isNullable: true + returnType: + body: *ref_218 + isNullable: true + serializedName: WebApps_GetPremierAddOn + summary: Gets a named add-on of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName} + - defaultResponse: + isNullable: true + deprecated: false + description: Updates a named add-on of an app. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: AddPremierAddOn + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Add-on name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: premierAddOnName + serializedName: premierAddOnName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the edited premier add-on. + extensions: + x-ms-requestBody-name: premierAddOn + isConstant: false + isRequired: true + location: body + modelType: *ref_218 + name: + fixed: false + raw: premierAddOn + serializedName: premierAddOn + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_218 + isNullable: true + returnType: + body: *ref_218 + isNullable: true + serializedName: WebApps_AddPremierAddOn + summary: Updates a named add-on of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName} + - defaultResponse: + isNullable: true + deprecated: false + description: Delete a premier add-on from an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeletePremierAddOn + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Add-on name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: premierAddOnName + serializedName: premierAddOnName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeletePremierAddOn + summary: Delete a premier add-on from an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get list of processes for a web site, or a deployment slot, or for a + specific scaled-out instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListProcesses + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_201 + isNullable: true + returnType: + body: *ref_201 + isNullable: true + serializedName: WebApps_ListProcesses + summary: >- + Get list of processes for a web site, or a deployment slot, or for a + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetProcess + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_68 + isNullable: true + returnType: + body: *ref_68 + isNullable: true + serializedName: WebApps_GetProcess + summary: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Terminate a process by its ID for a web site, or a deployment slot, or + specific scaled-out instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteProcess + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteProcess + summary: >- + Terminate a process by its ID for a web site, or a deployment slot, or + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get a memory dump of a process by its ID for a specific scaled-out + instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetProcessDump + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: &ref_219 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_219 + isNullable: true + serializedName: WebApps_GetProcessDump + summary: >- + Get a memory dump of a process by its ID for a specific scaled-out + instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List module information for a process by its ID for a specific + scaled-out instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListProcessModules + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_203 + isNullable: true + returnType: + body: *ref_203 + isNullable: true + serializedName: WebApps_ListProcessModules + summary: >- + List module information for a process by its ID for a specific + scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetProcessModule + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Module base address. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: baseAddress + serializedName: baseAddress + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_66 + isNullable: true + returnType: + body: *ref_66 + isNullable: true + serializedName: WebApps_GetProcessModule + summary: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List the threads in a process by its ID for a specific scaled-out + instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListProcessThreads + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_204 + isNullable: true + returnType: + body: *ref_204 + isNullable: true + serializedName: WebApps_ListProcessThreads + summary: >- + List the threads in a process by its ID for a specific scaled-out + instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get thread information by Thread ID for a specific process, in a + specific scaled-out instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetProcessThread + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: TID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: threadId + serializedName: threadId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_65 + isNullable: true + returnType: + body: *ref_65 + isNullable: true + serializedName: WebApps_GetProcessThread + summary: >- + Get thread information by Thread ID for a specific process, in a + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads/{threadId} + - defaultResponse: + isNullable: true + deprecated: false + description: Get public certificates for an app or a deployment slot. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListPublicCertificates + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_220 + isNullable: true + returnType: + body: *ref_220 + isNullable: true + serializedName: WebApps_ListPublicCertificates + summary: Get public certificates for an app or a deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get the named public certificate for an app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetPublicCertificate + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Public certificate name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publicCertificateName + serializedName: publicCertificateName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_71 + isNullable: true + returnType: + body: *ref_71 + isNullable: true + serializedName: WebApps_GetPublicCertificate + summary: >- + Get the named public certificate for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName} + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a hostname binding for an app. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdatePublicCertificate + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Public certificate name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publicCertificateName + serializedName: publicCertificateName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Public certificate details. This is the JSON representation of a + PublicCertificate object. + extensions: + x-ms-requestBody-name: publicCertificate + isConstant: false + isRequired: true + location: body + modelType: *ref_71 + name: + fixed: false + raw: publicCertificate + serializedName: publicCertificate + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_71 + isNullable: true + returnType: + body: *ref_71 + isNullable: true + serializedName: WebApps_CreateOrUpdatePublicCertificate + summary: Creates a hostname binding for an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a hostname binding for an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeletePublicCertificate + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Public certificate name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publicCertificateName + serializedName: publicCertificateName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeletePublicCertificate + summary: Deletes a hostname binding for an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the publishing profile for an app (or deployment slot, if + specified). + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListPublishingProfileXmlWithSecrets + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies publishingProfileOptions for publishing profile. For + example, use {"format": "FileZilla3"} to get a FileZilla + publishing profile. + extensions: + x-ms-requestBody-name: publishingProfileOptions + isConstant: false + isRequired: true + location: body + modelType: *ref_221 + name: + fixed: false + raw: publishingProfileOptions + serializedName: publishingProfileOptions + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/xml + responses: + OK: + body: &ref_222 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_222 + isNullable: true + serializedName: WebApps_ListPublishingProfileXmlWithSecrets + summary: >- + Gets the publishing profile for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml + - defaultResponse: + isNullable: true + deprecated: false + description: Recovers a web app to a previous snapshot. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Recover + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Snapshot data used for web app recovery. Snapshot information + can be obtained by calling GetDeletedSites or GetSiteSnapshots + API. + extensions: + x-ms-requestBody-name: recoveryEntity + isConstant: false + isRequired: true + location: body + modelType: *ref_124 + name: + fixed: false + raw: recoveryEntity + serializedName: recoveryEntity + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_Recover + summary: Recovers a web app to a previous snapshot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Resets the configuration settings of the current slot if they were + previously modified by calling the API with POST. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ResetProductionSlotConfig + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_ResetProductionSlotConfig + summary: >- + Resets the configuration settings of the current slot if they were + previously modified by calling the API with POST. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig + - defaultResponse: + isNullable: true + deprecated: false + description: 'Restarts an app (or deployment slot, if specified).' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Restart + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specify true to apply the configuration settings and restarts + the app only if necessary. By default, the API always restarts + and reprovisions the app. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: softRestart + serializedName: softRestart + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specify true to block until the app is restarted. By default, it + is set to false, and the API responds immediately + (asynchronous). + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: synchronous + serializedName: synchronous + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_Restart + summary: 'Restarts an app (or deployment slot, if specified).' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart + - defaultResponse: + isNullable: true + deprecated: false + description: 'Get list of siteextensions for a web site, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListSiteExtensions + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_223 + isNullable: true + returnType: + body: *ref_223 + isNullable: true + serializedName: WebApps_ListSiteExtensions + summary: 'Get list of siteextensions for a web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get site extension information by its ID for a web site, or a + deployment slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetSiteExtension + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site extension name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: siteExtensionId + serializedName: siteExtensionId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_110 + isNullable: true + returnType: + body: *ref_110 + isNullable: true + serializedName: WebApps_GetSiteExtension + summary: >- + Get site extension information by its ID for a web site, or a + deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Install site extension on a web site, or a deployment slot.' + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: InstallSiteExtension + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site extension name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: siteExtensionId + serializedName: siteExtensionId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + '429': + isNullable: true + Created: + body: *ref_110 + isNullable: true + OK: + body: *ref_110 + isNullable: true + returnType: + body: *ref_110 + isNullable: true + serializedName: WebApps_InstallSiteExtension + summary: 'Install site extension on a web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Remove a site extension from a web site, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteSiteExtension + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site extension name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: siteExtensionId + serializedName: siteExtensionId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteSiteExtension + summary: 'Remove a site extension from a web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets an app's deployment slots. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListSlots + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_168 + isNullable: true + returnType: + body: *ref_168 + isNullable: true + serializedName: WebApps_ListSlots + summary: Gets an app's deployment slots. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots + - defaultResponse: + isNullable: true + deprecated: false + description: 'Gets the details of a web, mobile, or API app.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. By default, this API returns the + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_167 + isNullable: true + returnType: + body: *ref_167 + isNullable: true + serializedName: WebApps_GetSlot + summary: 'Gets the details of a web, mobile, or API app.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a new web, mobile, or API app in an existing resource group, + or updates an existing app. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unique name of the app to create or update. To create or update + a deployment slot, use the {slot} parameter. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the app properties. See example. + extensions: + x-ms-requestBody-name: siteEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_167 + name: + fixed: false + raw: siteEnvelope + serializedName: siteEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot to create or update. By default, + this API attempts to create or modify the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true web app hostname is not registered with DNS on creation. + This parameter is + only used for app creation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipDnsRegistration + serializedName: skipDnsRegistration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true, custom (non *.azurewebsites.net) domains associated + with web app are not verified. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipCustomDomainVerification + serializedName: skipCustomDomainVerification + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If true, web app hostname is force registered with DNS.' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: forceDnsRegistration + serializedName: forceDnsRegistration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time to live in seconds for web app's default domain name. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ttlInSeconds + serializedName: ttlInSeconds + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_167 + isNullable: true + OK: + body: *ref_167 + isNullable: true + returnType: + body: *ref_167 + isNullable: true + serializedName: WebApps_CreateOrUpdateSlot + summary: >- + Creates a new web, mobile, or API app in an existing resource group, + or updates an existing app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Deletes a web, mobile, or API app, or one of the deployment slots.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app to delete. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot to delete. By default, the API + deletes the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If true, web app metrics are also deleted.' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: deleteMetrics + serializedName: deleteMetrics + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specify true if the App Service plan will be empty after app + deletion and you want to delete the empty App Service plan. By + default, the empty App Service plan is not deleted. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: deleteEmptyServerFarm + serializedName: deleteEmptyServerFarm + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If true, DNS registration is skipped.' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipDnsRegistration + serializedName: skipDnsRegistration + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteSlot + summary: 'Deletes a web, mobile, or API app, or one of the deployment slots.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a new web, mobile, or API app in an existing resource group, + or updates an existing app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Unique name of the app to create or update. To create or update + a deployment slot, use the {slot} parameter. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the app properties. See example. + extensions: + x-ms-requestBody-name: siteEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_172 + name: + fixed: false + raw: siteEnvelope + serializedName: siteEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot to create or update. By default, + this API attempts to create or modify the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true web app hostname is not registered with DNS on creation. + This parameter is + only used for app creation. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipDnsRegistration + serializedName: skipDnsRegistration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + If true, custom (non *.azurewebsites.net) domains associated + with web app are not verified. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: skipCustomDomainVerification + serializedName: skipCustomDomainVerification + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'If true, web app hostname is force registered with DNS.' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: forceDnsRegistration + serializedName: forceDnsRegistration + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Time to live in seconds for web app's default domain name. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: ttlInSeconds + serializedName: ttlInSeconds + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + body: *ref_167 + isNullable: true + OK: + body: *ref_167 + isNullable: true + returnType: + body: *ref_167 + isNullable: true + serializedName: WebApps_UpdateSlot + summary: >- + Creates a new web, mobile, or API app in an existing resource group, + or updates an existing app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot} + - defaultResponse: + isNullable: true + deprecated: false + description: Analyze a custom hostname. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: AnalyzeCustomHostnameSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Custom hostname. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostName + serializedName: hostName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_173 + isNullable: true + returnType: + body: *ref_173 + isNullable: true + serializedName: WebApps_AnalyzeCustomHostnameSlot + summary: Analyze a custom hostname. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Applies the configuration settings from the target slot onto the + current slot. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ApplySlotConfigurationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON object that contains the target slot name. See example. + extensions: + x-ms-requestBody-name: slotSwapEntity + isConstant: false + isRequired: true + location: body + modelType: *ref_174 + name: + fixed: false + raw: slotSwapEntity + serializedName: slotSwapEntity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the source slot. If a slot is not specified, the + production slot is used as the source slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_ApplySlotConfigurationSlot + summary: >- + Applies the configuration settings from the target slot onto the + current slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a backup of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: BackupSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Backup configuration. You can use the JSON response from the + POST action as input here. + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_175 + name: + fixed: false + raw: request + serializedName: request + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will create a backup for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: WebApps_BackupSlot + summary: Creates a backup of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup + - defaultResponse: + isNullable: true + deprecated: false + description: Gets existing backups of an app. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListBackupsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get backups of the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_176 + isNullable: true + returnType: + body: *ref_176 + isNullable: true + serializedName: WebApps_ListBackupsSlot + summary: Gets existing backups of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Discovers an existing app backup that can be restored from a blob in + Azure storage. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: DiscoverRestoreSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A RestoreRequest object that includes Azure storage URL and blog + name for discovery of backup. + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_177 + name: + fixed: false + raw: request + serializedName: request + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will perform discovery for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_177 + isNullable: true + returnType: + body: *ref_177 + isNullable: true + serializedName: WebApps_DiscoverRestoreSlot + summary: >- + Discovers an existing app backup that can be restored from a blob in + Azure storage. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a backup of an app by its ID. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetBackupStatusSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of the backup. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: backupId + serializedName: backupId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get a backup of the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: WebApps_GetBackupStatusSlot + summary: Gets a backup of an app by its ID. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a backup of an app by its ID. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteBackupSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of the backup. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: backupId + serializedName: backupId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete a backup of the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteBackupSlot + summary: Deletes a backup of an app by its ID. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets status of a web app backup that may be in progress, including + secrets associated with the backup, such as the Azure Storage SAS URL. + Also can be used to update the SAS URL for the backup if a new URL is + passed in the request body. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListBackupStatusSecretsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of backup. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: backupId + serializedName: backupId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Information on backup request. + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_175 + name: + fixed: false + raw: request + serializedName: request + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_8 + isNullable: true + returnType: + body: *ref_8 + isNullable: true + serializedName: WebApps_ListBackupStatusSecretsSlot + summary: >- + Gets status of a web app backup that may be in progress, including + secrets associated with the backup, such as the Azure Storage SAS URL. + Also can be used to update the SAS URL for the backup if a new URL is + passed in the request body. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Restores a specific backup to another app (or deployment slot, if + specified). + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: RestoreSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of the backup. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: backupId + serializedName: backupId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Information on restore request . + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_177 + name: + fixed: false + raw: request + serializedName: request + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will restore a backup of the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_178 + isNullable: true + returnType: + body: *ref_178 + isNullable: true + serializedName: WebApps_RestoreSlot + summary: >- + Restores a specific backup to another app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore + - defaultResponse: + isNullable: true + deprecated: false + description: List the configurations of an app + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListConfigurationsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will return configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_179 + isNullable: true + returnType: + body: *ref_179 + isNullable: true + serializedName: WebApps_ListConfigurationsSlot + summary: List the configurations of an app + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config + - defaultResponse: + isNullable: true + deprecated: false + description: Replaces the application settings of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateApplicationSettingsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Application settings of the app. + extensions: + x-ms-requestBody-name: appSettings + isConstant: false + isRequired: true + location: body + modelType: *ref_180 + name: + fixed: false + raw: appSettings + serializedName: appSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update the application settings for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_180 + isNullable: true + returnType: + body: *ref_180 + isNullable: true + serializedName: WebApps_UpdateApplicationSettingsSlot + summary: Replaces the application settings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the application settings of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListApplicationSettingsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the application settings for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_180 + isNullable: true + returnType: + body: *ref_180 + isNullable: true + serializedName: WebApps_ListApplicationSettingsSlot + summary: Gets the application settings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Updates the Authentication / Authorization settings associated with + web app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateAuthSettingsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Auth settings associated with web app. + extensions: + x-ms-requestBody-name: siteAuthSettings + isConstant: false + isRequired: true + location: body + modelType: *ref_181 + name: + fixed: false + raw: siteAuthSettings + serializedName: siteAuthSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_181 + isNullable: true + returnType: + body: *ref_181 + isNullable: true + serializedName: WebApps_UpdateAuthSettingsSlot + summary: >- + Updates the Authentication / Authorization settings associated with + web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the Authentication/Authorization settings of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GetAuthSettingsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the settings for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_181 + isNullable: true + returnType: + body: *ref_181 + isNullable: true + serializedName: WebApps_GetAuthSettingsSlot + summary: Gets the Authentication/Authorization settings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the backup configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateBackupConfigurationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Edited backup configuration. + extensions: + x-ms-requestBody-name: request + isConstant: false + isRequired: true + location: body + modelType: *ref_175 + name: + fixed: false + raw: request + serializedName: request + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update the backup configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_175 + isNullable: true + returnType: + body: *ref_175 + isNullable: true + serializedName: WebApps_UpdateBackupConfigurationSlot + summary: Updates the backup configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes the backup configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteBackupConfigurationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the backup configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteBackupConfigurationSlot + summary: Deletes the backup configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the backup configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GetBackupConfigurationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the backup configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_175 + isNullable: true + returnType: + body: *ref_175 + isNullable: true + serializedName: WebApps_GetBackupConfigurationSlot + summary: Gets the backup configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list + - defaultResponse: + isNullable: true + deprecated: false + description: Replaces the connection strings of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateConnectionStringsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Connection strings of the app or deployment slot. See example. + extensions: + x-ms-requestBody-name: connectionStrings + isConstant: false + isRequired: true + location: body + modelType: *ref_182 + name: + fixed: false + raw: connectionStrings + serializedName: connectionStrings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update the connection settings for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_182 + isNullable: true + returnType: + body: *ref_182 + isNullable: true + serializedName: WebApps_UpdateConnectionStringsSlot + summary: Replaces the connection strings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the connection strings of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListConnectionStringsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the connection settings for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_182 + isNullable: true + returnType: + body: *ref_182 + isNullable: true + serializedName: WebApps_ListConnectionStringsSlot + summary: Gets the connection strings of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the logging configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetDiagnosticLogsConfigurationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the logging configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_183 + isNullable: true + returnType: + body: *ref_183 + isNullable: true + serializedName: WebApps_GetDiagnosticLogsConfigurationSlot + summary: Gets the logging configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the logging configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateDiagnosticLogsConfigSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A SiteLogsConfig JSON object that contains the logging + configuration to change in the "properties" property. + extensions: + x-ms-requestBody-name: siteLogsConfig + isConstant: false + isRequired: true + location: body + modelType: *ref_183 + name: + fixed: false + raw: siteLogsConfig + serializedName: siteLogsConfig + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update the logging configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_183 + isNullable: true + returnType: + body: *ref_183 + isNullable: true + serializedName: WebApps_UpdateDiagnosticLogsConfigSlot + summary: Updates the logging configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs + - defaultResponse: + isNullable: true + deprecated: false + description: Replaces the metadata of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateMetadataSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Edited metadata of the app or deployment slot. See example. + extensions: + x-ms-requestBody-name: metadata + isConstant: false + isRequired: true + location: body + modelType: *ref_180 + name: + fixed: false + raw: metadata + serializedName: metadata + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update the metadata for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_180 + isNullable: true + returnType: + body: *ref_180 + isNullable: true + serializedName: WebApps_UpdateMetadataSlot + summary: Replaces the metadata of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the metadata of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListMetadataSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the metadata for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_180 + isNullable: true + returnType: + body: *ref_180 + isNullable: true + serializedName: WebApps_ListMetadataSlot + summary: Gets the metadata of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the Git/FTP publishing credentials of an app. + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListPublishingCredentialsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the publishing credentials for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_184 + isNullable: true + returnType: + body: *ref_184 + isNullable: true + serializedName: WebApps_ListPublishingCredentialsSlot + summary: Gets the Git/FTP publishing credentials of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the Push settings associated with web app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateSitePushSettingsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Push settings associated with web app. + extensions: + x-ms-requestBody-name: pushSettings + isConstant: false + isRequired: true + location: body + modelType: *ref_101 + name: + fixed: false + raw: pushSettings + serializedName: pushSettings + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_101 + isNullable: true + returnType: + body: *ref_101 + isNullable: true + serializedName: WebApps_UpdateSitePushSettingsSlot + summary: Updates the Push settings associated with web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the Push settings associated with web app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListSitePushSettingsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_101 + isNullable: true + returnType: + body: *ref_101 + isNullable: true + serializedName: WebApps_ListSitePushSettingsSlot + summary: Gets the Push settings associated with web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the configuration of an app, such as platform version and + bitness, default documents, virtual applications, Always On, etc. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetConfigurationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will return configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_105 + isNullable: true + returnType: + body: *ref_105 + isNullable: true + serializedName: WebApps_GetConfigurationSlot + summary: >- + Gets the configuration of an app, such as platform version and + bitness, default documents, virtual applications, Always On, etc. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateConfigurationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON representation of a SiteConfig object. See example. + extensions: + x-ms-requestBody-name: siteConfig + isConstant: false + isRequired: true + location: body + modelType: *ref_105 + name: + fixed: false + raw: siteConfig + serializedName: siteConfig + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_105 + isNullable: true + returnType: + body: *ref_105 + isNullable: true + serializedName: WebApps_CreateOrUpdateConfigurationSlot + summary: Updates the configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateConfigurationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON representation of a SiteConfig object. See example. + extensions: + x-ms-requestBody-name: siteConfig + isConstant: false + isRequired: true + location: body + modelType: *ref_105 + name: + fixed: false + raw: siteConfig + serializedName: siteConfig + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_105 + isNullable: true + returnType: + body: *ref_105 + isNullable: true + serializedName: WebApps_UpdateConfigurationSlot + summary: Updates the configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a list of web app configuration snapshots identifiers. Each + element of the list contains a timestamp and the ID of the snapshot. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListConfigurationSnapshotInfoSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will return configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_186 + isNullable: true + returnType: + body: *ref_186 + isNullable: true + serializedName: WebApps_ListConfigurationSnapshotInfoSlot + summary: >- + Gets a list of web app configuration snapshots identifiers. Each + element of the list contains a timestamp and the ID of the snapshot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a snapshot of the configuration of an app at a previous point in + time. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetConfigurationSnapshotSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the snapshot to read. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: snapshotId + serializedName: snapshotId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will return configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_105 + isNullable: true + returnType: + body: *ref_105 + isNullable: true + serializedName: WebApps_GetConfigurationSnapshotSlot + summary: >- + Gets a snapshot of the configuration of an app at a previous point in + time. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId} + - defaultResponse: + isNullable: true + deprecated: false + description: Reverts the configuration of an app to a previous snapshot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: RecoverSiteConfigurationSnapshotSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The ID of the snapshot to read. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: snapshotId + serializedName: snapshotId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will return configuration for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_RecoverSiteConfigurationSnapshotSlot + summary: Reverts the configuration of an app to a previous snapshot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the last lines of docker logs for the given site + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GetWebSiteContainerLogsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: &ref_224 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_224 + isNullable: true + serializedName: WebApps_GetWebSiteContainerLogsSlot + summary: Gets the last lines of docker logs for the given site + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the ZIP archived docker log files for the given site + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GetContainerLogsZipSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + body: &ref_225 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_225 + isNullable: true + serializedName: WebApps_GetContainerLogsZipSlot + summary: Gets the ZIP archived docker log files for the given site + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download + - defaultResponse: + isNullable: true + deprecated: false + description: 'List continuous web jobs for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListContinuousWebJobsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_189 + isNullable: true + returnType: + body: *ref_189 + isNullable: true + serializedName: WebApps_ListContinuousWebJobsSlot + summary: 'List continuous web jobs for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs + - defaultResponse: + isNullable: true + deprecated: false + description: 'Gets a continuous web job by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetContinuousWebJobSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_19 + isNullable: true + returnType: + body: *ref_19 + isNullable: true + serializedName: WebApps_GetContinuousWebJobSlot + summary: 'Gets a continuous web job by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Delete a continuous web job by its ID for an app, or a deployment + slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteContinuousWebJobSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteContinuousWebJobSlot + summary: >- + Delete a continuous web job by its ID for an app, or a deployment + slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Start a continuous web job for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StartContinuousWebJobSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_StartContinuousWebJobSlot + summary: 'Start a continuous web job for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start + - defaultResponse: + isNullable: true + deprecated: false + description: 'Stop a continuous web job for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StopContinuousWebJobSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_StopContinuousWebJobSlot + summary: 'Stop a continuous web job for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop + - defaultResponse: + isNullable: true + deprecated: false + description: 'List deployments for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListDeploymentsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_190 + isNullable: true + returnType: + body: *ref_190 + isNullable: true + serializedName: WebApps_ListDeploymentsSlot + summary: 'List deployments for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments + - defaultResponse: + isNullable: true + deprecated: false + description: 'Get a deployment by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetDeploymentSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Deployment ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + gets a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_25 + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: WebApps_GetDeploymentSlot + summary: 'Get a deployment by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Create a deployment for an app, or a deployment slot.' + extensions: + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateDeploymentSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of an existing deployment. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + creates a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Deployment details. + extensions: + x-ms-requestBody-name: deployment + isConstant: false + isRequired: true + location: body + modelType: *ref_25 + name: + fixed: false + raw: deployment + serializedName: deployment + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_25 + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: WebApps_CreateDeploymentSlot + summary: 'Create a deployment for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Delete a deployment by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteDeploymentSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Deployment ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteDeploymentSlot + summary: 'Delete a deployment by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List deployment log for specific deployment for an app, or a + deployment slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListDeploymentLogSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The ID of a specific deployment. This is the value of the name + property in the JSON response from "GET + /api/sites/{siteName}/deployments". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_25 + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: WebApps_ListDeploymentLogSlot + summary: >- + List deployment log for specific deployment for an app, or a + deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log + - defaultResponse: + isNullable: true + deprecated: false + description: Lists ownership identifiers for domain associated with web app. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListDomainOwnershipIdentifiersSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_191 + isNullable: true + returnType: + body: *ref_191 + isNullable: true + serializedName: WebApps_ListDomainOwnershipIdentifiersSlot + summary: Lists ownership identifiers for domain associated with web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers + - defaultResponse: + isNullable: true + deprecated: false + description: Get domain ownership identifier for web app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetDomainOwnershipIdentifierSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of domain ownership identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainOwnershipIdentifierName + serializedName: domainOwnershipIdentifierName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_38 + isNullable: true + returnType: + body: *ref_38 + isNullable: true + serializedName: WebApps_GetDomainOwnershipIdentifierSlot + summary: Get domain ownership identifier for web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a domain ownership identifier for web app, or updates an + existing ownership identifier. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateDomainOwnershipIdentifierSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of domain ownership identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainOwnershipIdentifierName + serializedName: domainOwnershipIdentifierName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the domain ownership properties. + extensions: + x-ms-requestBody-name: domainOwnershipIdentifier + isConstant: false + isRequired: true + location: body + modelType: *ref_38 + name: + fixed: false + raw: domainOwnershipIdentifier + serializedName: domainOwnershipIdentifier + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_38 + isNullable: true + returnType: + body: *ref_38 + isNullable: true + serializedName: WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot + summary: >- + Creates a domain ownership identifier for web app, or updates an + existing ownership identifier. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a domain ownership identifier for a web app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteDomainOwnershipIdentifierSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of domain ownership identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainOwnershipIdentifierName + serializedName: domainOwnershipIdentifierName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteDomainOwnershipIdentifierSlot + summary: Deletes a domain ownership identifier for a web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a domain ownership identifier for web app, or updates an + existing ownership identifier. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateDomainOwnershipIdentifierSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of domain ownership identifier. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: domainOwnershipIdentifierName + serializedName: domainOwnershipIdentifierName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the domain ownership properties. + extensions: + x-ms-requestBody-name: domainOwnershipIdentifier + isConstant: false + isRequired: true + location: body + modelType: *ref_38 + name: + fixed: false + raw: domainOwnershipIdentifier + serializedName: domainOwnershipIdentifier + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_38 + isNullable: true + returnType: + body: *ref_38 + isNullable: true + serializedName: WebApps_UpdateDomainOwnershipIdentifierSlot + summary: >- + Creates a domain ownership identifier for web app, or updates an + existing ownership identifier. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} + - defaultResponse: + isNullable: true + deprecated: false + description: Get the status of the last MSDeploy operation. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetMSDeployStatusSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_192 + isNullable: true + returnType: + body: *ref_192 + isNullable: true + serializedName: WebApps_GetMSDeployStatusSlot + summary: Get the status of the last MSDeploy operation. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy + - defaultResponse: + isNullable: true + deprecated: false + description: Invoke the MSDeploy web app extension. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateMSDeployOperationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details of MSDeploy operation + extensions: + x-ms-requestBody-name: MSDeploy + isConstant: false + isRequired: true + location: body + modelType: *ref_193 + name: + fixed: false + raw: MSDeploy + serializedName: MSDeploy + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Conflict: + isNullable: true + Created: + body: *ref_192 + isNullable: true + returnType: + body: *ref_192 + isNullable: true + serializedName: WebApps_CreateMSDeployOperationSlot + summary: Invoke the MSDeploy web app extension. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy + - defaultResponse: + isNullable: true + deprecated: false + description: Get the MSDeploy Log for the last MSDeploy operation. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetMSDeployLogSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_194 + isNullable: true + returnType: + body: *ref_194 + isNullable: true + serializedName: WebApps_GetMSDeployLogSlot + summary: Get the MSDeploy Log for the last MSDeploy operation. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log + - defaultResponse: + isNullable: true + deprecated: false + description: 'List the functions for a web site, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListInstanceFunctionsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_195 + isNullable: true + returnType: + body: *ref_195 + isNullable: true + serializedName: WebApps_ListInstanceFunctionsSlot + summary: 'List the functions for a web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions + - defaultResponse: + isNullable: true + deprecated: false + description: Fetch a short lived token that can be exchanged for a master key. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetFunctionsAdminTokenSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_226 + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_226 + isNullable: true + serializedName: WebApps_GetFunctionsAdminTokenSlot + summary: Fetch a short lived token that can be exchanged for a master key. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token + - defaultResponse: + isNullable: true + deprecated: false + description: 'Get function information by its ID for web site, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceFunctionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: functionName + serializedName: functionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: WebApps_GetInstanceFunctionSlot + summary: 'Get function information by its ID for web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Create function for web site, or a deployment slot.' + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateInstanceFunctionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: functionName + serializedName: functionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function details. + extensions: + x-ms-requestBody-name: function_envelope + isConstant: false + isRequired: true + location: body + modelType: *ref_27 + name: + fixed: false + raw: function_envelope + serializedName: function_envelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: WebApps_CreateInstanceFunctionSlot + summary: 'Create function for web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Delete a function for web site, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteInstanceFunctionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: functionName + serializedName: functionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteInstanceFunctionSlot + summary: 'Delete a function for web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get function secrets for a function in a web site, or a deployment + slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListFunctionSecretsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Function name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: functionName + serializedName: functionName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_197 + isNullable: true + returnType: + body: *ref_197 + isNullable: true + serializedName: WebApps_ListFunctionSecretsSlot + summary: >- + Get function secrets for a function in a web site, or a deployment + slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets + - defaultResponse: + isNullable: true + deprecated: false + description: Get hostname bindings for an app or a deployment slot. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListHostNameBindingsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + gets hostname bindings for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_198 + isNullable: true + returnType: + body: *ref_198 + isNullable: true + serializedName: WebApps_ListHostNameBindingsSlot + summary: Get hostname bindings for an app or a deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get the named hostname binding for an app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetHostNameBindingSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + the named binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostname in the hostname binding. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostName + serializedName: hostName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_34 + isNullable: true + returnType: + body: *ref_34 + isNullable: true + serializedName: WebApps_GetHostNameBindingSlot + summary: >- + Get the named hostname binding for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName} + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a hostname binding for an app. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateHostNameBindingSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostname in the hostname binding. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostName + serializedName: hostName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Binding details. This is the JSON representation of a + HostNameBinding object. + extensions: + x-ms-requestBody-name: hostNameBinding + isConstant: false + isRequired: true + location: body + modelType: *ref_34 + name: + fixed: false + raw: hostNameBinding + serializedName: hostNameBinding + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will create a binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_34 + isNullable: true + returnType: + body: *ref_34 + isNullable: true + serializedName: WebApps_CreateOrUpdateHostNameBindingSlot + summary: Creates a hostname binding for an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a hostname binding for an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteHostNameBindingSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Hostname in the hostname binding. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: hostName + serializedName: hostName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteHostNameBindingSlot + summary: Deletes a hostname binding for an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Retrieves a specific Service Bus Hybrid Connection used by this Web + App. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetHybridConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the slot for the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_57 + isNullable: true + returnType: + body: *ref_57 + isNullable: true + serializedName: WebApps_GetHybridConnectionSlot + summary: >- + Retrieves a specific Service Bus Hybrid Connection used by this Web + App. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a new Hybrid Connection using a Service Bus relay. + extensions: + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateHybridConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The details of the hybrid connection. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_57 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the slot for the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_57 + isNullable: true + returnType: + body: *ref_57 + isNullable: true + serializedName: WebApps_CreateOrUpdateHybridConnectionSlot + summary: Creates a new Hybrid Connection using a Service Bus relay. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} + - defaultResponse: + isNullable: true + deprecated: false + description: Removes a Hybrid Connection from this site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteHybridConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the slot for the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteHybridConnectionSlot + summary: Removes a Hybrid Connection from this site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a new Hybrid Connection using a Service Bus relay. + extensions: + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateHybridConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The details of the hybrid connection. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_57 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the slot for the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_57 + isNullable: true + returnType: + body: *ref_57 + isNullable: true + serializedName: WebApps_UpdateHybridConnectionSlot + summary: Creates a new Hybrid Connection using a Service Bus relay. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the send key name and value for a Hybrid Connection. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListHybridConnectionKeysSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The namespace for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: namespaceName + serializedName: namespaceName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The relay name for this hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: relayName + serializedName: relayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the slot for the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_199 + isNullable: true + returnType: + body: *ref_199 + isNullable: true + serializedName: WebApps_ListHybridConnectionKeysSlot + summary: Gets the send key name and value for a Hybrid Connection. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys + - defaultResponse: + isNullable: true + deprecated: false + description: Retrieves all Service Bus Hybrid Connections used by this Web App. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListHybridConnectionsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the slot for the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_57 + isNullable: true + returnType: + body: *ref_57 + isNullable: true + serializedName: WebApps_ListHybridConnectionsSlot + summary: Retrieves all Service Bus Hybrid Connections used by this Web App. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets hybrid connections configured for an app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListRelayServiceConnectionsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get hybrid connections for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_56 + isNullable: true + returnType: + body: *ref_56 + isNullable: true + serializedName: WebApps_ListRelayServiceConnectionsSlot + summary: >- + Gets hybrid connections configured for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a hybrid connection configuration by its name. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetRelayServiceConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the hybrid connection. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityName + serializedName: entityName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get a hybrid connection for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_56 + isNullable: true + returnType: + body: *ref_56 + isNullable: true + serializedName: WebApps_GetRelayServiceConnectionSlot + summary: Gets a hybrid connection configuration by its name. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a new hybrid connection configuration (PUT), or updates an + existing one (PATCH). + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateRelayServiceConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the hybrid connection configuration. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityName + serializedName: entityName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details of the hybrid connection configuration. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_56 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will create or update a hybrid connection for the production + slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_56 + isNullable: true + returnType: + body: *ref_56 + isNullable: true + serializedName: WebApps_CreateOrUpdateRelayServiceConnectionSlot + summary: >- + Creates a new hybrid connection configuration (PUT), or updates an + existing one (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a relay service connection by its name. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteRelayServiceConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the hybrid connection configuration. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityName + serializedName: entityName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete a hybrid connection for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteRelayServiceConnectionSlot + summary: Deletes a relay service connection by its name. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Creates a new hybrid connection configuration (PUT), or updates an + existing one (PATCH). + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateRelayServiceConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the hybrid connection configuration. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: entityName + serializedName: entityName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details of the hybrid connection configuration. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_56 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will create or update a hybrid connection for the production + slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_56 + isNullable: true + returnType: + body: *ref_56 + isNullable: true + serializedName: WebApps_UpdateRelayServiceConnectionSlot + summary: >- + Creates a new hybrid connection configuration (PUT), or updates an + existing one (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets all scale-out instances of an app. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListInstanceIdentifiersSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + gets the production slot instances. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_200 + isNullable: true + returnType: + body: *ref_200 + isNullable: true + serializedName: WebApps_ListInstanceIdentifiersSlot + summary: Gets all scale-out instances of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances + - defaultResponse: + isNullable: true + deprecated: false + description: Get the status of the last MSDeploy operation. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceMsDeployStatusSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of web app instance. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_192 + isNullable: true + returnType: + body: *ref_192 + isNullable: true + serializedName: WebApps_GetInstanceMsDeployStatusSlot + summary: Get the status of the last MSDeploy operation. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy + - defaultResponse: + isNullable: true + deprecated: false + description: Invoke the MSDeploy web app extension. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateInstanceMSDeployOperationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of web app instance. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Details of MSDeploy operation + extensions: + x-ms-requestBody-name: MSDeploy + isConstant: false + isRequired: true + location: body + modelType: *ref_193 + name: + fixed: false + raw: MSDeploy + serializedName: MSDeploy + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Conflict: + isNullable: true + Created: + body: *ref_192 + isNullable: true + returnType: + body: *ref_192 + isNullable: true + serializedName: WebApps_CreateInstanceMSDeployOperationSlot + summary: Invoke the MSDeploy web app extension. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy + - defaultResponse: + isNullable: true + deprecated: false + description: Get the MSDeploy Log for the last MSDeploy operation. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceMSDeployLogSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: ID of web app instance. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_194 + isNullable: true + returnType: + body: *ref_194 + isNullable: true + serializedName: WebApps_GetInstanceMSDeployLogSlot + summary: Get the MSDeploy Log for the last MSDeploy operation. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get list of processes for a web site, or a deployment slot, or for a + specific scaled-out instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListInstanceProcessesSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_201 + isNullable: true + returnType: + body: *ref_201 + isNullable: true + serializedName: WebApps_ListInstanceProcessesSlot + summary: >- + Get list of processes for a web site, or a deployment slot, or for a + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceProcessSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_68 + isNullable: true + returnType: + body: *ref_68 + isNullable: true + serializedName: WebApps_GetInstanceProcessSlot + summary: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Terminate a process by its ID for a web site, or a deployment slot, or + specific scaled-out instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteInstanceProcessSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteInstanceProcessSlot + summary: >- + Terminate a process by its ID for a web site, or a deployment slot, or + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get a memory dump of a process by its ID for a specific scaled-out + instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceProcessDumpSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: &ref_227 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_227 + isNullable: true + serializedName: WebApps_GetInstanceProcessDumpSlot + summary: >- + Get a memory dump of a process by its ID for a specific scaled-out + instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List module information for a process by its ID for a specific + scaled-out instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListInstanceProcessModulesSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_203 + isNullable: true + returnType: + body: *ref_203 + isNullable: true + serializedName: WebApps_ListInstanceProcessModulesSlot + summary: >- + List module information for a process by its ID for a specific + scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceProcessModuleSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Module base address. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: baseAddress + serializedName: baseAddress + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_66 + isNullable: true + returnType: + body: *ref_66 + isNullable: true + serializedName: WebApps_GetInstanceProcessModuleSlot + summary: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List the threads in a process by its ID for a specific scaled-out + instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListInstanceProcessThreadsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_204 + isNullable: true + returnType: + body: *ref_204 + isNullable: true + serializedName: WebApps_ListInstanceProcessThreadsSlot + summary: >- + List the threads in a process by its ID for a specific scaled-out + instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get thread information by Thread ID for a specific process, in a + specific scaled-out instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetInstanceProcessThreadSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: TID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: threadId + serializedName: threadId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + ID of a specific scaled-out instance. This is the value of the + name property in the JSON response from "GET + api/sites/{siteName}/instances". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: instanceId + serializedName: instanceId + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_65 + isNullable: true + returnType: + body: *ref_65 + isNullable: true + serializedName: WebApps_GetInstanceProcessThreadSlot + summary: >- + Get thread information by Thread ID for a specific process, in a + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads/{threadId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Shows whether an app can be cloned to another resource group or + subscription. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: IsCloneableSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. By default, this API returns + information on the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_205 + isNullable: true + returnType: + body: *ref_205 + isNullable: true + serializedName: WebApps_IsCloneableSlot + summary: >- + Shows whether an app can be cloned to another resource group or + subscription. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable + - defaultResponse: + isNullable: true + deprecated: false + description: This is to allow calling via powershell and ARM template. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListSyncFunctionTriggersSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will restore a backup of the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_197 + isNullable: true + returnType: + body: *ref_197 + isNullable: true + serializedName: WebApps_ListSyncFunctionTriggersSlot + summary: This is to allow calling via powershell and ARM template. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets all metric definitions of an app (or deployment slot, if + specified). + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListMetricDefinitionsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get metric definitions of the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_206 + isNullable: true + returnType: + body: *ref_206 + isNullable: true + serializedName: WebApps_ListMetricDefinitionsSlot + summary: >- + Gets all metric definitions of an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions + - defaultResponse: + isNullable: true + deprecated: false + description: 'Gets performance metrics of an app (or deployment slot, if specified).' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListMetricsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get metrics of the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specify "true" to include metric details in the response. It is + "false" by default. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: details + serializedName: details + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Return only metrics specified in the filter (using OData + syntax). For example: $filter=(name.value eq 'Metric1' or + name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' + and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq + duration'[Hour|Minute|Day]'. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_207 + isNullable: true + returnType: + body: *ref_207 + isNullable: true + serializedName: WebApps_ListMetricsSlot + summary: 'Gets performance metrics of an app (or deployment slot, if specified).' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Returns the status of MySql in app migration, if one is active, and + whether or not MySql in app is enabled + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetMigrateMySqlStatusSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the deployment slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_212 + isNullable: true + returnType: + body: *ref_212 + isNullable: true + serializedName: WebApps_GetMigrateMySqlStatusSlot + summary: >- + Returns the status of MySql in app migration, if one is active, and + whether or not MySql in app is enabled + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets all network features used by the app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListNetworkFeaturesSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The type of view. This can either be "summary" or "detailed". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: view + serializedName: view + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get network features for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_213 + isNullable: true + returnType: + body: *ref_213 + isNullable: true + serializedName: WebApps_ListNetworkFeaturesSlot + summary: >- + Gets all network features used by the app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view} + - defaultResponse: + isNullable: true + deprecated: false + description: Start capturing network packets for the site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StartWebSiteNetworkTraceSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The duration to keep capturing in seconds. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: durationInSeconds + serializedName: durationInSeconds + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the slot for this web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The maximum frame length in bytes (Optional). + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: maxFrameLength + serializedName: maxFrameLength + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The Blob URL to store capture file. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: sasUrl + serializedName: sasUrl + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_228 + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_228 + isNullable: true + serializedName: WebApps_StartWebSiteNetworkTraceSlot + summary: Start capturing network packets for the site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start + - defaultResponse: + isNullable: true + deprecated: false + description: Stop ongoing capturing network packets for the site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StopWebSiteNetworkTraceSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the slot for this web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_229 + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + isNullable: true + returnType: + body: *ref_229 + isNullable: true + serializedName: WebApps_StopWebSiteNetworkTraceSlot + summary: Stop ongoing capturing network packets for the site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Generates a new publishing password for an app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: GenerateNewSitePublishingPasswordSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + generate a new publishing password for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_GenerateNewSitePublishingPasswordSlot + summary: >- + Generates a new publishing password for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword + - defaultResponse: + isNullable: true + deprecated: false + description: Gets perfmon counters for web app. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListPerfMonCountersSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Return only usages/metrics specified in the filter. Filter + conforms to odata syntax. Example: $filter=(startTime eq + '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and + timeGrain eq duration'[Hour|Minute|Day]'. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_216 + isNullable: true + returnType: + body: *ref_216 + isNullable: true + serializedName: WebApps_ListPerfMonCountersSlot + summary: Gets perfmon counters for web app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters + - defaultResponse: + isNullable: true + deprecated: false + description: Gets web app's event logs. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetSitePhpErrorLogFlagSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_217 + isNullable: true + returnType: + body: *ref_217 + isNullable: true + serializedName: WebApps_GetSitePhpErrorLogFlagSlot + summary: Gets web app's event logs. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the premier add-ons of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListPremierAddOnsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the premier add-ons for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_218 + isNullable: true + returnType: + body: *ref_218 + isNullable: true + serializedName: WebApps_ListPremierAddOnsSlot + summary: Gets the premier add-ons of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons + - defaultResponse: + isNullable: true + deprecated: false + description: Gets a named add-on of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetPremierAddOnSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Add-on name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: premierAddOnName + serializedName: premierAddOnName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the named add-on for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_218 + isNullable: true + returnType: + body: *ref_218 + isNullable: true + serializedName: WebApps_GetPremierAddOnSlot + summary: Gets a named add-on of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName} + - defaultResponse: + isNullable: true + deprecated: false + description: Updates a named add-on of an app. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: AddPremierAddOnSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Add-on name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: premierAddOnName + serializedName: premierAddOnName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A JSON representation of the edited premier add-on. + extensions: + x-ms-requestBody-name: premierAddOn + isConstant: false + isRequired: true + location: body + modelType: *ref_218 + name: + fixed: false + raw: premierAddOn + serializedName: premierAddOn + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update the named add-on for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_218 + isNullable: true + returnType: + body: *ref_218 + isNullable: true + serializedName: WebApps_AddPremierAddOnSlot + summary: Updates a named add-on of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName} + - defaultResponse: + isNullable: true + deprecated: false + description: Delete a premier add-on from an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeletePremierAddOnSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Add-on name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: premierAddOnName + serializedName: premierAddOnName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the named add-on for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeletePremierAddOnSlot + summary: Delete a premier add-on from an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get list of processes for a web site, or a deployment slot, or for a + specific scaled-out instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListProcessesSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_201 + isNullable: true + returnType: + body: *ref_201 + isNullable: true + serializedName: WebApps_ListProcessesSlot + summary: >- + Get list of processes for a web site, or a deployment slot, or for a + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetProcessSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_68 + isNullable: true + returnType: + body: *ref_68 + isNullable: true + serializedName: WebApps_GetProcessSlot + summary: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Terminate a process by its ID for a web site, or a deployment slot, or + specific scaled-out instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteProcessSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteProcessSlot + summary: >- + Terminate a process by its ID for a web site, or a deployment slot, or + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get a memory dump of a process by its ID for a specific scaled-out + instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetProcessDumpSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: &ref_230 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_230 + isNullable: true + serializedName: WebApps_GetProcessDumpSlot + summary: >- + Get a memory dump of a process by its ID for a specific scaled-out + instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List module information for a process by its ID for a specific + scaled-out instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListProcessModulesSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_203 + isNullable: true + returnType: + body: *ref_203 + isNullable: true + serializedName: WebApps_ListProcessModulesSlot + summary: >- + List module information for a process by its ID for a specific + scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetProcessModuleSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Module base address. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: baseAddress + serializedName: baseAddress + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_66 + isNullable: true + returnType: + body: *ref_66 + isNullable: true + serializedName: WebApps_GetProcessModuleSlot + summary: >- + Get process information by its ID for a specific scaled-out instance + in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + List the threads in a process by its ID for a specific scaled-out + instance in a web site. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListProcessThreadsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_204 + isNullable: true + returnType: + body: *ref_204 + isNullable: true + serializedName: WebApps_ListProcessThreadsSlot + summary: >- + List the threads in a process by its ID for a specific scaled-out + instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get thread information by Thread ID for a specific process, in a + specific scaled-out instance in a web site. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetProcessThreadSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: PID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: processId + serializedName: processId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: TID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: threadId + serializedName: threadId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_65 + isNullable: true + returnType: + body: *ref_65 + isNullable: true + serializedName: WebApps_GetProcessThreadSlot + summary: >- + Get thread information by Thread ID for a specific process, in a + specific scaled-out instance in a web site. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads/{threadId} + - defaultResponse: + isNullable: true + deprecated: false + description: Get public certificates for an app or a deployment slot. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListPublicCertificatesSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + gets hostname bindings for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_220 + isNullable: true + returnType: + body: *ref_220 + isNullable: true + serializedName: WebApps_ListPublicCertificatesSlot + summary: Get public certificates for an app or a deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get the named public certificate for an app (or deployment slot, if + specified). + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetPublicCertificateSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + the named binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Public certificate name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publicCertificateName + serializedName: publicCertificateName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_71 + isNullable: true + returnType: + body: *ref_71 + isNullable: true + serializedName: WebApps_GetPublicCertificateSlot + summary: >- + Get the named public certificate for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName} + - defaultResponse: + isNullable: true + deprecated: false + description: Creates a hostname binding for an app. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdatePublicCertificateSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Public certificate name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publicCertificateName + serializedName: publicCertificateName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Public certificate details. This is the JSON representation of a + PublicCertificate object. + extensions: + x-ms-requestBody-name: publicCertificate + isConstant: false + isRequired: true + location: body + modelType: *ref_71 + name: + fixed: false + raw: publicCertificate + serializedName: publicCertificate + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will create a binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_71 + isNullable: true + returnType: + body: *ref_71 + isNullable: true + serializedName: WebApps_CreateOrUpdatePublicCertificateSlot + summary: Creates a hostname binding for an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a hostname binding for an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeletePublicCertificateSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the binding for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Public certificate name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: publicCertificateName + serializedName: publicCertificateName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeletePublicCertificateSlot + summary: Deletes a hostname binding for an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the publishing profile for an app (or deployment slot, if + specified). + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListPublishingProfileXmlWithSecretsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specifies publishingProfileOptions for publishing profile. For + example, use {"format": "FileZilla3"} to get a FileZilla + publishing profile. + extensions: + x-ms-requestBody-name: publishingProfileOptions + isConstant: false + isRequired: true + location: body + modelType: *ref_221 + name: + fixed: false + raw: publishingProfileOptions + serializedName: publishingProfileOptions + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the publishing profile for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/xml + responses: + OK: + body: &ref_231 + $type: PrimaryType + knownPrimaryType: stream + name: + fixed: false + raw: Stream + isNullable: true + returnType: + body: *ref_231 + isNullable: true + serializedName: WebApps_ListPublishingProfileXmlWithSecretsSlot + summary: >- + Gets the publishing profile for an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml + - defaultResponse: + isNullable: true + deprecated: false + description: Recovers a web app to a previous snapshot. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: RecoverSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Snapshot data used for web app recovery. Snapshot information + can be obtained by calling GetDeletedSites or GetSiteSnapshots + API. + extensions: + x-ms-requestBody-name: recoveryEntity + isConstant: false + isRequired: true + location: body + modelType: *ref_124 + name: + fixed: false + raw: recoveryEntity + serializedName: recoveryEntity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_RecoverSlot + summary: Recovers a web app to a previous snapshot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Resets the configuration settings of the current slot if they were + previously modified by calling the API with POST. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ResetSlotConfigurationSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + resets configuration settings for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_ResetSlotConfigurationSlot + summary: >- + Resets the configuration settings of the current slot if they were + previously modified by calling the API with POST. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig + - defaultResponse: + isNullable: true + deprecated: false + description: 'Restarts an app (or deployment slot, if specified).' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: RestartSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will restart the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specify true to apply the configuration settings and restarts + the app only if necessary. By default, the API always restarts + and reprovisions the app. + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: softRestart + serializedName: softRestart + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Specify true to block until the app is restarted. By default, it + is set to false, and the API responds immediately + (asynchronous). + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: synchronous + serializedName: synchronous + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_RestartSlot + summary: 'Restarts an app (or deployment slot, if specified).' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart + - defaultResponse: + isNullable: true + deprecated: false + description: 'Get list of siteextensions for a web site, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListSiteExtensionsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_223 + isNullable: true + returnType: + body: *ref_223 + isNullable: true + serializedName: WebApps_ListSiteExtensionsSlot + summary: 'Get list of siteextensions for a web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get site extension information by its ID for a web site, or a + deployment slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetSiteExtensionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site extension name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: siteExtensionId + serializedName: siteExtensionId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_110 + isNullable: true + returnType: + body: *ref_110 + isNullable: true + serializedName: WebApps_GetSiteExtensionSlot + summary: >- + Get site extension information by its ID for a web site, or a + deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Install site extension on a web site, or a deployment slot.' + extensions: + x-ms-long-running-operation: true + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: InstallSiteExtensionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site extension name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: siteExtensionId + serializedName: siteExtensionId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + '429': + isNullable: true + Created: + body: *ref_110 + isNullable: true + OK: + body: *ref_110 + isNullable: true + returnType: + body: *ref_110 + isNullable: true + serializedName: WebApps_InstallSiteExtensionSlot + summary: 'Install site extension on a web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Remove a site extension from a web site, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteSiteExtensionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site extension name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: siteExtensionId + serializedName: siteExtensionId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + NotFound: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteSiteExtensionSlot + summary: 'Remove a site extension from a web site, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get the difference in configuration settings between two web app + slots. + extensions: + x-ms-pageable: + nextLinkName: nextLink + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListSlotDifferencesSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON object that contains the target slot name. See example. + extensions: + x-ms-requestBody-name: slotSwapEntity + isConstant: false + isRequired: true + location: body + modelType: *ref_174 + name: + fixed: false + raw: slotSwapEntity + serializedName: slotSwapEntity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the source slot. If a slot is not specified, the + production slot is used as the source slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_232 + isNullable: true + returnType: + body: *ref_232 + isNullable: true + serializedName: WebApps_ListSlotDifferencesSlot + summary: >- + Get the difference in configuration settings between two web app + slots. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs + - defaultResponse: + isNullable: true + deprecated: false + description: Swaps two deployment slots of an app. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: SwapSlotSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON object that contains the target slot name. See example. + extensions: + x-ms-requestBody-name: slotSwapEntity + isConstant: false + isRequired: true + location: body + modelType: *ref_174 + name: + fixed: false + raw: slotSwapEntity + serializedName: slotSwapEntity + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the source slot. If a slot is not specified, the + production slot is used as the source slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_SwapSlotSlot + summary: Swaps two deployment slots of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap + - defaultResponse: + isNullable: true + deprecated: false + description: Returns all Snapshots to the user. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListSnapshotsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Website Name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Website Slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_233 + isNullable: true + returnType: + body: *ref_233 + isNullable: true + serializedName: WebApps_ListSnapshotsSlot + summary: Returns all Snapshots to the user. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the source control configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetSourceControlSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the source control configuration for the production + slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_234 + isNullable: true + returnType: + body: *ref_234 + isNullable: true + serializedName: WebApps_GetSourceControlSlot + summary: Gets the source control configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the source control configuration of an app. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateSourceControlSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON representation of a SiteSourceControl object. See example. + extensions: + x-ms-requestBody-name: siteSourceControl + isConstant: false + isRequired: true + location: body + modelType: *ref_234 + name: + fixed: false + raw: siteSourceControl + serializedName: siteSourceControl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update the source control configuration for the production + slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_234 + isNullable: true + OK: + body: *ref_234 + isNullable: true + returnType: + body: *ref_234 + isNullable: true + serializedName: WebApps_CreateOrUpdateSourceControlSlot + summary: Updates the source control configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes the source control configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteSourceControlSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the source control configuration for the production + slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteSourceControlSlot + summary: Deletes the source control configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the source control configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateSourceControlSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON representation of a SiteSourceControl object. See example. + extensions: + x-ms-requestBody-name: siteSourceControl + isConstant: false + isRequired: true + location: body + modelType: *ref_234 + name: + fixed: false + raw: siteSourceControl + serializedName: siteSourceControl + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will update the source control configuration for the production + slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_234 + isNullable: true + OK: + body: *ref_234 + isNullable: true + returnType: + body: *ref_234 + isNullable: true + serializedName: WebApps_UpdateSourceControlSlot + summary: Updates the source control configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web + - defaultResponse: + isNullable: true + deprecated: false + description: 'Starts an app (or deployment slot, if specified).' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StartSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will start the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_StartSlot + summary: 'Starts an app (or deployment slot, if specified).' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start + - defaultResponse: + isNullable: true + deprecated: false + description: 'Stops an app (or deployment slot, if specified).' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: StopSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will stop the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_StopSlot + summary: 'Stops an app (or deployment slot, if specified).' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop + - defaultResponse: + isNullable: true + deprecated: false + description: Sync web app repository. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: SyncRepositorySlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of web app slot. If not specified then will default to + production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_SyncRepositorySlot + summary: Sync web app repository. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync + - defaultResponse: + isNullable: true + deprecated: false + description: Syncs function trigger metadata to the scale controller + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: SyncFunctionTriggersSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will restore a backup of the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_SyncFunctionTriggersSlot + summary: Syncs function trigger metadata to the scale controller + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers + - defaultResponse: + isNullable: true + deprecated: false + description: 'List triggered web jobs for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListTriggeredWebJobsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_235 + isNullable: true + returnType: + body: *ref_235 + isNullable: true + serializedName: WebApps_ListTriggeredWebJobsSlot + summary: 'List triggered web jobs for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs + - defaultResponse: + isNullable: true + deprecated: false + description: 'Gets a triggered web job by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetTriggeredWebJobSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_142 + isNullable: true + returnType: + body: *ref_142 + isNullable: true + serializedName: WebApps_GetTriggeredWebJobSlot + summary: 'Gets a triggered web job by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Delete a triggered web job by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteTriggeredWebJobSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteTriggeredWebJobSlot + summary: 'Delete a triggered web job by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'List a triggered web job''s history for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListTriggeredWebJobHistorySlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_236 + isNullable: true + returnType: + body: *ref_236 + isNullable: true + serializedName: WebApps_ListTriggeredWebJobHistorySlot + summary: 'List a triggered web job''s history for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a triggered web job's history by its ID for an app, , or a + deployment slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetTriggeredWebJobHistorySlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: History ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_140 + isNullable: true + returnType: + body: *ref_140 + isNullable: true + serializedName: WebApps_GetTriggeredWebJobHistorySlot + summary: >- + Gets a triggered web job's history by its ID for an app, , or a + deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Run a triggered web job for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: RunTriggeredWebJobSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + deletes a deployment for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_RunTriggeredWebJobSlot + summary: 'Run a triggered web job for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the quota usage information of an app (or deployment slot, if + specified). + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListUsagesSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get quota information of the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Return only information specified in the filter (using OData + syntax). For example: $filter=(name.value eq 'Metric1' or + name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' + and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq + duration'[Hour|Minute|Day]'. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_237 + isNullable: true + returnType: + body: *ref_237 + isNullable: true + serializedName: WebApps_ListUsagesSlot + summary: >- + Gets the quota usage information of an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the virtual networks the app (or deployment slot) is connected + to. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListVnetConnectionsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get virtual network connections for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_238 + $type: SequenceType + elementType: *ref_55 + name: + fixed: false + isNullable: true + returnType: + body: *ref_238 + isNullable: true + serializedName: WebApps_ListVnetConnectionsSlot + summary: >- + Gets the virtual networks the app (or deployment slot) is connected + to. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a virtual network the app (or deployment slot) is connected to by + name. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetVnetConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the virtual network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get the named virtual network for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_55 + isNullable: true + returnType: + body: *ref_55 + isNullable: true + serializedName: WebApps_GetVnetConnectionSlot + summary: >- + Gets a virtual network the app (or deployment slot) is connected to by + name. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Adds a Virtual Network connection to an app or slot (PUT) or updates + the connection properties (PATCH). + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateVnetConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of an existing Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Properties of the Virtual Network connection. See example. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_55 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will add or update connections for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_55 + isNullable: true + returnType: + body: *ref_55 + isNullable: true + serializedName: WebApps_CreateOrUpdateVnetConnectionSlot + summary: >- + Adds a Virtual Network connection to an app or slot (PUT) or updates + the connection properties (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Deletes a connection from an app (or deployment slot to a named + virtual network. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteVnetConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the virtual network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will delete the connection for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteVnetConnectionSlot + summary: >- + Deletes a connection from an app (or deployment slot to a named + virtual network. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Adds a Virtual Network connection to an app or slot (PUT) or updates + the connection properties (PATCH). + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateVnetConnectionSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of an existing Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Properties of the Virtual Network connection. See example. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_55 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will add or update connections for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_55 + isNullable: true + returnType: + body: *ref_55 + isNullable: true + serializedName: WebApps_UpdateVnetConnectionSlot + summary: >- + Adds a Virtual Network connection to an app or slot (PUT) or updates + the connection properties (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets an app's Virtual Network gateway. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetVnetConnectionGatewaySlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the gateway. Currently, the only supported string is + "primary". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: gatewayName + serializedName: gatewayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will get a gateway for the production slot's Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_239 + isNullable: true + returnType: + body: *ref_239 + isNullable: true + serializedName: WebApps_GetVnetConnectionGatewaySlot + summary: Gets an app's Virtual Network gateway. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Adds a gateway to a connected Virtual Network (PUT) or updates it + (PATCH). + extensions: + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateVnetConnectionGatewaySlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the gateway. Currently, the only supported string is + "primary". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: gatewayName + serializedName: gatewayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The properties to update this gateway with. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_239 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will add or update a gateway for the production slot's Virtual + Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_239 + isNullable: true + returnType: + body: *ref_239 + isNullable: true + serializedName: WebApps_CreateOrUpdateVnetConnectionGatewaySlot + summary: >- + Adds a gateway to a connected Virtual Network (PUT) or updates it + (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Adds a gateway to a connected Virtual Network (PUT) or updates it + (PATCH). + extensions: + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateVnetConnectionGatewaySlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the gateway. Currently, the only supported string is + "primary". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: gatewayName + serializedName: gatewayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The properties to update this gateway with. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_239 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + will add or update a gateway for the production slot's Virtual + Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_239 + isNullable: true + returnType: + body: *ref_239 + isNullable: true + serializedName: WebApps_UpdateVnetConnectionGatewaySlot + summary: >- + Adds a gateway to a connected Virtual Network (PUT) or updates it + (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'List webjobs for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListWebJobsSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_240 + isNullable: true + returnType: + body: *ref_240 + isNullable: true + serializedName: WebApps_ListWebJobsSlot + summary: 'List webjobs for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs + - defaultResponse: + isNullable: true + deprecated: false + description: 'Get webjob information for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetWebJobSlot + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the web job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the deployment slot. If a slot is not specified, the API + returns deployments for the production slot. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: slot + serializedName: slot + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_145 + isNullable: true + returnType: + body: *ref_145 + isNullable: true + serializedName: WebApps_GetWebJobSlot + summary: 'Get webjob information for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Get the difference in configuration settings between two web app + slots. + extensions: + x-ms-pageable: + nextLinkName: nextLink + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListSlotDifferencesFromProduction + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON object that contains the target slot name. See example. + extensions: + x-ms-requestBody-name: slotSwapEntity + isConstant: false + isRequired: true + location: body + modelType: *ref_174 + name: + fixed: false + raw: slotSwapEntity + serializedName: slotSwapEntity + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_232 + isNullable: true + returnType: + body: *ref_232 + isNullable: true + serializedName: WebApps_ListSlotDifferencesFromProduction + summary: >- + Get the difference in configuration settings between two web app + slots. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs + - defaultResponse: + isNullable: true + deprecated: false + description: Swaps two deployment slots of an app. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: SwapSlotWithProduction + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON object that contains the target slot name. See example. + extensions: + x-ms-requestBody-name: slotSwapEntity + isConstant: false + isRequired: true + location: body + modelType: *ref_174 + name: + fixed: false + raw: slotSwapEntity + serializedName: slotSwapEntity + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_SwapSlotWithProduction + summary: Swaps two deployment slots of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap + - defaultResponse: + isNullable: true + deprecated: false + description: Returns all Snapshots to the user. + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListSnapshots + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Website Name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_233 + isNullable: true + returnType: + body: *ref_233 + isNullable: true + serializedName: WebApps_ListSnapshots + summary: Returns all Snapshots to the user. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots + - defaultResponse: + isNullable: true + deprecated: false + description: Gets the source control configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetSourceControl + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_234 + isNullable: true + returnType: + body: *ref_234 + isNullable: true + serializedName: WebApps_GetSourceControl + summary: Gets the source control configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the source control configuration of an app. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateSourceControl + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON representation of a SiteSourceControl object. See example. + extensions: + x-ms-requestBody-name: siteSourceControl + isConstant: false + isRequired: true + location: body + modelType: *ref_234 + name: + fixed: false + raw: siteSourceControl + serializedName: siteSourceControl + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_234 + isNullable: true + OK: + body: *ref_234 + isNullable: true + returnType: + body: *ref_234 + isNullable: true + serializedName: WebApps_CreateOrUpdateSourceControl + summary: Updates the source control configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes the source control configuration of an app. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteSourceControl + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Accepted: + isNullable: true + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteSourceControl + summary: Deletes the source control configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web + - defaultResponse: + isNullable: true + deprecated: false + description: Updates the source control configuration of an app. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateSourceControl + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: JSON representation of a SiteSourceControl object. See example. + extensions: + x-ms-requestBody-name: siteSourceControl + isConstant: false + isRequired: true + location: body + modelType: *ref_234 + name: + fixed: false + raw: siteSourceControl + serializedName: siteSourceControl + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + Created: + body: *ref_234 + isNullable: true + OK: + body: *ref_234 + isNullable: true + returnType: + body: *ref_234 + isNullable: true + serializedName: WebApps_UpdateSourceControl + summary: Updates the source control configuration of an app. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web + - defaultResponse: + isNullable: true + deprecated: false + description: 'Starts an app (or deployment slot, if specified).' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Start + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_Start + summary: 'Starts an app (or deployment slot, if specified).' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start + - defaultResponse: + isNullable: true + deprecated: false + description: 'Stops an app (or deployment slot, if specified).' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: Stop + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_Stop + summary: 'Stops an app (or deployment slot, if specified).' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop + - defaultResponse: + isNullable: true + deprecated: false + description: Sync web app repository. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: SyncRepository + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of web app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_SyncRepository + summary: Sync web app repository. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync + - defaultResponse: + isNullable: true + deprecated: false + description: Syncs function trigger metadata to the scale controller + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: SyncFunctionTriggers + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_SyncFunctionTriggers + summary: Syncs function trigger metadata to the scale controller + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers + - defaultResponse: + isNullable: true + deprecated: false + description: 'List triggered web jobs for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListTriggeredWebJobs + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_235 + isNullable: true + returnType: + body: *ref_235 + isNullable: true + serializedName: WebApps_ListTriggeredWebJobs + summary: 'List triggered web jobs for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs + - defaultResponse: + isNullable: true + deprecated: false + description: 'Gets a triggered web job by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetTriggeredWebJob + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_142 + isNullable: true + returnType: + body: *ref_142 + isNullable: true + serializedName: WebApps_GetTriggeredWebJob + summary: 'Gets a triggered web job by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Delete a triggered web job by its ID for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteTriggeredWebJob + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteTriggeredWebJob + summary: 'Delete a triggered web job by its ID for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'List a triggered web job''s history for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListTriggeredWebJobHistory + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_236 + isNullable: true + returnType: + body: *ref_236 + isNullable: true + serializedName: WebApps_ListTriggeredWebJobHistory + summary: 'List a triggered web job''s history for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a triggered web job's history by its ID for an app, , or a + deployment slot. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetTriggeredWebJobHistory + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: History ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + serializedName: id + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_140 + isNullable: true + returnType: + body: *ref_140 + isNullable: true + serializedName: WebApps_GetTriggeredWebJobHistory + summary: >- + Gets a triggered web job's history by its ID for an app, , or a + deployment slot. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id} + - defaultResponse: + isNullable: true + deprecated: false + description: 'Run a triggered web job for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: RunTriggeredWebJob + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of Web Job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_RunTriggeredWebJob + summary: 'Run a triggered web job for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the quota usage information of an app (or deployment slot, if + specified). + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListUsages + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Return only information specified in the filter (using OData + syntax). For example: $filter=(name.value eq 'Metric1' or + name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' + and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq + duration'[Hour|Minute|Day]'. + extensions: + x-ms-skip-url-encoding: true + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: $filter + serializedName: $filter + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_237 + isNullable: true + returnType: + body: *ref_237 + isNullable: true + serializedName: WebApps_ListUsages + summary: >- + Gets the quota usage information of an app (or deployment slot, if + specified). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the virtual networks the app (or deployment slot) is connected + to. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListVnetConnections + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: &ref_241 + $type: SequenceType + elementType: *ref_55 + name: + fixed: false + isNullable: true + returnType: + body: *ref_241 + isNullable: true + serializedName: WebApps_ListVnetConnections + summary: >- + Gets the virtual networks the app (or deployment slot) is connected + to. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets a virtual network the app (or deployment slot) is connected to by + name. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetVnetConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the virtual network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_55 + isNullable: true + returnType: + body: *ref_55 + isNullable: true + serializedName: WebApps_GetVnetConnection + summary: >- + Gets a virtual network the app (or deployment slot) is connected to by + name. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Adds a Virtual Network connection to an app or slot (PUT) or updates + the connection properties (PATCH). + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateVnetConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of an existing Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Properties of the Virtual Network connection. See example. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_55 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_55 + isNullable: true + returnType: + body: *ref_55 + isNullable: true + serializedName: WebApps_CreateOrUpdateVnetConnection + summary: >- + Adds a Virtual Network connection to an app or slot (PUT) or updates + the connection properties (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Deletes a connection from an app (or deployment slot to a named + virtual network. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: DeleteVnetConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the virtual network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: WebApps_DeleteVnetConnection + summary: >- + Deletes a connection from an app (or deployment slot to a named + virtual network. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Adds a Virtual Network connection to an app or slot (PUT) or updates + the connection properties (PATCH). + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateVnetConnection + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of an existing Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Properties of the Virtual Network connection. See example. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_55 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_55 + isNullable: true + returnType: + body: *ref_55 + isNullable: true + serializedName: WebApps_UpdateVnetConnection + summary: >- + Adds a Virtual Network connection to an app or slot (PUT) or updates + the connection properties (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName} + - defaultResponse: + isNullable: true + deprecated: false + description: Gets an app's Virtual Network gateway. + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetVnetConnectionGateway + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the gateway. Currently, the only supported string is + "primary". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: gatewayName + serializedName: gatewayName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NotFound: + isNullable: true + OK: + body: *ref_239 + isNullable: true + returnType: + body: *ref_239 + isNullable: true + serializedName: WebApps_GetVnetConnectionGateway + summary: Gets an app's Virtual Network gateway. + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Adds a gateway to a connected Virtual Network (PUT) or updates it + (PATCH). + extensions: + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: CreateOrUpdateVnetConnectionGateway + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the gateway. Currently, the only supported string is + "primary". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: gatewayName + serializedName: gatewayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The properties to update this gateway with. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_239 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_239 + isNullable: true + returnType: + body: *ref_239 + isNullable: true + serializedName: WebApps_CreateOrUpdateVnetConnectionGateway + summary: >- + Adds a gateway to a connected Virtual Network (PUT) or updates it + (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Adds a gateway to a connected Virtual Network (PUT) or updates it + (PATCH). + extensions: + x-ms-requestBody-index: '4' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: UpdateVnetConnectionGateway + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the app. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the Virtual Network. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: vnetName + serializedName: vnetName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Name of the gateway. Currently, the only supported string is + "primary". + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: gatewayName + serializedName: gatewayName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The properties to update this gateway with. + extensions: + x-ms-requestBody-name: connectionEnvelope + isConstant: false + isRequired: true + location: body + modelType: *ref_239 + name: + fixed: false + raw: connectionEnvelope + serializedName: connectionEnvelope + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_239 + isNullable: true + returnType: + body: *ref_239 + isNullable: true + serializedName: WebApps_UpdateVnetConnectionGateway + summary: >- + Adds a gateway to a connected Virtual Network (PUT) or updates it + (PATCH). + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} + - defaultResponse: + isNullable: true + deprecated: false + description: 'List webjobs for an app, or a deployment slot.' + extensions: + x-ms-pageable: + nextLinkName: nextLink + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListWebJobs + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_240 + isNullable: true + returnType: + body: *ref_240 + isNullable: true + serializedName: WebApps_ListWebJobs + summary: 'List webjobs for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs + - defaultResponse: + isNullable: true + deprecated: false + description: 'Get webjob information for an app, or a deployment slot.' + group: + fixed: false + raw: WebApps + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetWebJob + parameters: + - clientProperty: *ref_171 + collectionFormat: none + constraints: + MaxLength: '90' + MinLength: '1' + Pattern: '^[-\w\._\(\)]+[^\.]$' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the resource group to which the resource belongs. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Site name. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Name of the web job. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: webJobName + serializedName: webJobName + - clientProperty: *ref_169 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Your Azure subscription ID. This is a GUID-formatted string + (e.g. 00000000-0000-0000-0000-000000000000). + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - clientProperty: *ref_170 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_145 + isNullable: true + returnType: + body: *ref_145 + isNullable: true + serializedName: WebApps_GetWebJob + summary: 'Get webjob information for an app, or a deployment slot.' + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName} + name: + fixed: false + raw: WebApps + nameForProperty: WebApps + typeName: + fixed: false +properties: + - *ref_169 + - *ref_171 + - *ref_170 diff --git a/test/Expected/storage/code-model-v1-yaml.yaml b/test/Expected/storage/code-model-v1-yaml.yaml new file mode 100644 index 0000000..696858a --- /dev/null +++ b/test/Expected/storage/code-model-v1-yaml.yaml @@ -0,0 +1,2510 @@ +--- +apiVersion: 2015-05-01-preview +baseUrl: 'https://management.azure.com' +enumTypes: + - &ref_0 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: Reason + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: AccountNameInvalid + serializedName: AccountNameInvalid + - name: AlreadyExists + serializedName: AlreadyExists + - &ref_1 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: AccountType + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Standard_LRS + serializedName: Standard_LRS + - name: Standard_ZRS + serializedName: Standard_ZRS + - name: Standard_GRS + serializedName: Standard_GRS + - name: Standard_RAGRS + serializedName: Standard_RAGRS + - name: Premium_LRS + serializedName: Premium_LRS + - &ref_6 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: ProvisioningState + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Creating + serializedName: Creating + - name: ResolvingDNS + serializedName: ResolvingDNS + - name: Succeeded + serializedName: Succeeded + - &ref_7 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: AccountStatus + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Available + serializedName: Available + - name: Unavailable + serializedName: Unavailable + - &ref_13 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: KeyName + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: key1 + serializedName: key1 + - name: key2 + serializedName: key2 + - &ref_14 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: UsageUnit + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: Count + serializedName: Count + - name: Bytes + serializedName: Bytes + - name: Seconds + serializedName: Seconds + - name: Percent + serializedName: Percent + - name: CountsPerSecond + serializedName: CountsPerSecond + - name: BytesPerSecond + serializedName: BytesPerSecond +modelTypes: + - &ref_17 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: StorageAccountCheckNameAvailabilityParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + raw: Microsoft.Storage/storageAccounts + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + serializedName: StorageAccountCheckNameAvailabilityParameters + - &ref_18 + $type: CompositeType + containsConstantProperties: false + documentation: The CheckNameAvailability operation response. + name: + fixed: false + raw: CheckNameAvailabilityResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets a boolean value that indicates whether the name is available + for you to use. If true, the name is available. If false, the name + has already been taken or invalid and cannot be used. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: nameAvailable + realPath: + - nameAvailable + serializedName: nameAvailable + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets the reason that a storage account name could not be used. The + Reason element is only returned if NameAvailable is false. + extensions: + x-ms-enum: + name: Reason + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_0 + name: + fixed: false + raw: reason + realPath: + - reason + serializedName: reason + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets an error message explaining the Reason value in more detail. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: CheckNameAvailabilityResult + - &ref_2 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: StorageAccountPropertiesCreateParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets or sets the account type. + extensions: + x-ms-enum: + name: AccountType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: accountType + realPath: + - accountType + serializedName: accountType + serializedName: StorageAccountPropertiesCreateParameters + - &ref_19 + $type: CompositeType + baseModelType: &ref_9 + $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: Resource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource name + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource type + isConstant: false + isReadOnly: true + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: type + realPath: + - type + serializedName: type + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource location + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource tags + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: DictionaryType + name: + fixed: false + supportsAdditionalProperties: false + valueType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: tags + realPath: + - tags + serializedName: tags + serializedName: Resource + containsConstantProperties: false + documentation: The parameters to provide for the account. + name: + fixed: false + raw: StorageAccountCreateParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: StorageAccountCreateParameters + - &ref_4 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The URIs that are used to perform a retrieval of a public blob, queue or + table object. + name: + fixed: false + raw: Bar + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Recursive Endpoints + isConstant: false + isReadOnly: false + isRequired: false + modelType: &ref_3 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The URIs that are used to perform a retrieval of a public blob, + queue or table object. + name: + fixed: false + raw: Endpoints + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the blob endpoint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: blob + realPath: + - blob + serializedName: blob + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the queue endpoint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: queue + realPath: + - queue + serializedName: queue + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the table endpoint. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: table + realPath: + - table + serializedName: table + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Dummy EndPoint + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: dummyEndPoint + realPath: + - dummyEndPoint + serializedName: dummyEndPoint + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Foo point + isConstant: false + isReadOnly: false + isRequired: false + modelType: &ref_5 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The URIs that are used to perform a retrieval of a public + blob, queue or table object. + name: + fixed: false + raw: Foo + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Bar point + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_4 + name: + fixed: false + raw: Bar.Point + realPath: + - Bar.Point + serializedName: Bar.Point + serializedName: Foo + name: + fixed: false + raw: FooPoint + realPath: + - FooPoint + serializedName: FooPoint + serializedName: Endpoints + name: + fixed: false + raw: RecursivePoint + realPath: + - RecursivePoint + serializedName: RecursivePoint + serializedName: Bar + - *ref_5 + - *ref_3 + - &ref_8 + $type: CompositeType + containsConstantProperties: false + documentation: >- + The custom domain assigned to this storage account. This can be set via + Update. + name: + fixed: false + raw: CustomDomain + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets or sets the custom domain name. Name is the CNAME source. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Indicates whether indirect CName validation is enabled. Default + value is false. This should only be set on updates + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: useSubDomain + realPath: + - useSubDomain + serializedName: useSubDomain + serializedName: CustomDomain + - &ref_10 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: StorageAccountProperties + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets the status of the storage account at the time the operation was + called. + extensions: + x-ms-enum: + name: ProvisioningState + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_6 + name: + fixed: false + raw: provisioningState + realPath: + - provisioningState + serializedName: provisioningState + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the type of the storage account. + extensions: + x-ms-enum: + name: AccountType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: accountType + realPath: + - accountType + serializedName: accountType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: primaryEndpoints + realPath: + - primaryEndpoints + serializedName: primaryEndpoints + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the location of the primary for the storage account. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: primaryLocation + realPath: + - primaryLocation + serializedName: primaryLocation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets the status indicating whether the primary location of the + storage account is available or unavailable. + extensions: + x-ms-enum: + name: AccountStatus + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_7 + name: + fixed: false + raw: statusOfPrimary + realPath: + - statusOfPrimary + serializedName: statusOfPrimary + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: lastGeoFailoverTime + realPath: + - lastGeoFailoverTime + serializedName: lastGeoFailoverTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets the location of the geo replicated secondary for the storage + account. Only available if the accountType is StandardGRS or + StandardRAGRS. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: secondaryLocation + realPath: + - secondaryLocation + serializedName: secondaryLocation + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + extensions: + x-ms-enum: + name: AccountStatus + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_7 + name: + fixed: false + raw: statusOfSecondary + realPath: + - statusOfSecondary + serializedName: statusOfSecondary + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the creation date and time of the storage account in UTC. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: creationTime + realPath: + - creationTime + serializedName: creationTime + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets the user assigned custom domain assigned to this storage + account. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_8 + name: + fixed: false + raw: customDomain + realPath: + - customDomain + serializedName: customDomain + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_3 + name: + fixed: false + raw: secondaryEndpoints + realPath: + - secondaryEndpoints + serializedName: secondaryEndpoints + serializedName: StorageAccountProperties + - &ref_11 + $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: The storage account. + name: + fixed: false + raw: StorageAccount + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_10 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: StorageAccount + - &ref_24 + $type: CompositeType + containsConstantProperties: false + documentation: The access keys for the storage account. + name: + fixed: false + raw: StorageAccountKeys + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the value of key 1. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: key1 + realPath: + - key1 + serializedName: key1 + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the value of key 2. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: key2 + realPath: + - key2 + serializedName: key2 + serializedName: StorageAccountKeys + - &ref_25 + $type: CompositeType + containsConstantProperties: false + documentation: The list storage accounts operation response. + name: + fixed: false + raw: StorageAccountListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the list of storage accounts and their properties. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_11 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets the link to the next set of results. Currently this will always + be empty as the API does not support pagination. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: nextLink + realPath: + - nextLink + serializedName: nextLink + serializedName: StorageAccountListResult + - &ref_12 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: StorageAccountPropertiesUpdateParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + extensions: + x-ms-enum: + name: AccountType + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_1 + name: + fixed: false + raw: accountType + realPath: + - accountType + serializedName: accountType + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + 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. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_8 + name: + fixed: false + raw: customDomain + realPath: + - customDomain + serializedName: customDomain + serializedName: StorageAccountPropertiesUpdateParameters + - &ref_23 + $type: CompositeType + baseModelType: *ref_9 + containsConstantProperties: false + documentation: The parameters to update on the account. + name: + fixed: false + raw: StorageAccountUpdateParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-client-flatten: true + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_12 + name: + fixed: false + raw: properties + realPath: + - properties + serializedName: properties + serializedName: StorageAccountUpdateParameters + - &ref_26 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: StorageAccountRegenerateKeyParameters + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-enum: + name: KeyName + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_13 + name: + fixed: false + raw: keyName + realPath: + - keyName + serializedName: keyName + serializedName: StorageAccountRegenerateKeyParameters + - &ref_15 + $type: CompositeType + containsConstantProperties: false + documentation: The Usage Names. + name: + fixed: false + raw: UsageName + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets a string describing the resource name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets a localized string describing the resource name. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localizedValue + realPath: + - localizedValue + serializedName: localizedValue + serializedName: UsageName + - &ref_16 + $type: CompositeType + containsConstantProperties: false + documentation: Describes Storage Resource Usage. + name: + fixed: false + raw: Usage + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the unit of measurement. + extensions: + x-ms-enum: + name: UsageUnit + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_14 + name: + fixed: false + raw: unit + realPath: + - unit + serializedName: unit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets the current count of the allocated resources in the + subscription. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: currentValue + realPath: + - currentValue + serializedName: currentValue + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets the maximum count of the resources that can be allocated in the + subscription. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: limit + realPath: + - limit + serializedName: limit + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets the name of the type of usage. + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_15 + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + serializedName: Usage + - &ref_27 + $type: CompositeType + containsConstantProperties: false + documentation: The List Usages operation response. + name: + fixed: false + raw: UsageListResult + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Gets or sets the list Storage Resource Usages. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: *ref_16 + name: + fixed: false + name: + fixed: false + raw: value + realPath: + - value + serializedName: value + serializedName: UsageListResult + - *ref_9 + - $type: CompositeType + containsConstantProperties: false + extensions: + x-ms-azure-resource: true + name: + fixed: false + raw: SubResource + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Id + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: id + realPath: + - id + serializedName: id + serializedName: SubResource +modelsName: Models +name: StorageManagementClient +namespace: '' +operations: + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: Checks that account name is valid and is not in use. + extensions: + x-ms-requestBody-index: '0' + group: + fixed: false + raw: StorageAccounts + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: CheckNameAvailability + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the storage account within the specified resource + group. Storage account names must be between 3 and 24 characters + in length and use numbers and lower-case letters only. + extensions: + x-ms-requestBody-name: accountName + isConstant: false + isRequired: true + location: body + modelType: *ref_17 + name: + fixed: false + raw: accountName + serializedName: accountName + - clientProperty: &ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: &ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify + Microsoft Azure subscription. The subscription ID forms part + of the URI for every service call. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + - text/json + responses: + OK: + body: *ref_18 + isNullable: true + returnType: + body: *ref_18 + isNullable: true + serializedName: StorageAccounts_CheckNameAvailability + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability + - defaultResponse: + isNullable: true + deprecated: false + 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. + extensions: + x-ms-long-running-operation: true + x-ms-requestBody-index: '2' + group: + fixed: false + raw: StorageAccounts + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: Create + parameters: + - clientProperty: &ref_22 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group within the user’s subscription. + extensions: + x-ms-parameter-location: method + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + realPath: + - resourceGroupName + serializedName: resourceGroupName + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group within the user’s subscription. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the storage account within the specified resource + group. Storage account names must be between 3 and 24 characters + in length and use numbers and lower-case letters only. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: accountName + serializedName: accountName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The parameters to provide for the created account. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_19 + name: + fixed: false + raw: parameters + serializedName: parameters + - clientProperty: *ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + - text/json + responses: + Accepted: + isNullable: true + OK: + body: *ref_11 + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: StorageAccounts_Create + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName} + - defaultResponse: + isNullable: true + deprecated: false + description: Deletes a storage account in Microsoft Azure. + group: + fixed: false + raw: StorageAccounts + hidden: false + httpMethod: delete + isAbsoluteUrl: false + name: + fixed: false + raw: Delete + parameters: + - clientProperty: *ref_22 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group within the user’s subscription. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the storage account within the specified resource + group. Storage account names must be between 3 and 24 characters + in length and use numbers and lower-case letters only. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: accountName + serializedName: accountName + - clientProperty: *ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + NoContent: + isNullable: true + OK: + isNullable: true + returnType: + isNullable: true + serializedName: StorageAccounts_Delete + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName} + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Returns the properties for the specified storage account including but + not limited to name, account type, location, and account status. The + ListKeys operation should be used to retrieve storage keys. + group: + fixed: false + raw: StorageAccounts + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: GetProperties + parameters: + - clientProperty: *ref_22 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group within the user’s subscription. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the storage account within the specified resource + group. Storage account names must be between 3 and 24 characters + in length and use numbers and lower-case letters only. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: accountName + serializedName: accountName + - clientProperty: *ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + - text/json + responses: + OK: + body: *ref_11 + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: StorageAccounts_GetProperties + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName} + - defaultResponse: + isNullable: true + deprecated: false + 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. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: StorageAccounts + hidden: false + httpMethod: patch + isAbsoluteUrl: false + name: + fixed: false + raw: Update + parameters: + - clientProperty: *ref_22 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group within the user’s subscription. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the storage account within the specified resource + group. Storage account names must be between 3 and 24 characters + in length and use numbers and lower-case letters only. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: accountName + serializedName: accountName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The parameters to update on the account. Note that only one + property can be changed at a time using this API. + extensions: + x-ms-requestBody-name: parameters + isConstant: false + isRequired: true + location: body + modelType: *ref_23 + name: + fixed: false + raw: parameters + serializedName: parameters + - clientProperty: *ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + - text/json + responses: + OK: + body: *ref_11 + isNullable: true + returnType: + body: *ref_11 + isNullable: true + serializedName: StorageAccounts_Update + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName} + - defaultResponse: + isNullable: true + deprecated: false + description: Lists the access keys for the specified storage account. + group: + fixed: false + raw: StorageAccounts + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: ListKeys + parameters: + - clientProperty: *ref_22 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group within the user’s subscription. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the storage account. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: accountName + serializedName: accountName + - clientProperty: *ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + - text/json + responses: + OK: + body: *ref_24 + isNullable: true + returnType: + body: *ref_24 + isNullable: true + serializedName: StorageAccounts_ListKeys + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Lists all the storage accounts available under the subscription. Note + that storage keys are not returned; use the ListKeys operation for + this. + extensions: + x-ms-pageable: + nextLinkName: null + group: + fixed: false + raw: StorageAccounts + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + - text/json + responses: + OK: + body: *ref_25 + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: StorageAccounts_List + url: >- + /subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Lists all the storage accounts available under the given resource + group. Note that storage keys are not returned; use the ListKeys + operation for this. + extensions: + x-ms-pageable: + nextLinkName: null + group: + fixed: false + raw: StorageAccounts + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ListByResourceGroup + parameters: + - clientProperty: *ref_22 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group within the user’s subscription. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: *ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + - text/json + responses: + OK: + body: *ref_25 + isNullable: true + returnType: + body: *ref_25 + isNullable: true + serializedName: StorageAccounts_ListByResourceGroup + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts + - defaultResponse: + isNullable: true + deprecated: false + description: Regenerates the access keys for the specified storage account. + extensions: + x-ms-requestBody-index: '2' + group: + fixed: false + raw: StorageAccounts + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: RegenerateKey + parameters: + - clientProperty: *ref_22 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: The name of the resource group within the user’s subscription. + extensions: + x-ms-parameter-location: method + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + The name of the storage account within the specified resource + group. Storage account names must be between 3 and 24 characters + in length and use numbers and lower-case letters only. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: accountName + serializedName: accountName + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Specifies name of the key which should be regenerated. + extensions: + x-ms-requestBody-name: regenerateKey + isConstant: false + isRequired: true + location: body + modelType: *ref_26 + name: + fixed: false + raw: regenerateKey + serializedName: regenerateKey + - clientProperty: *ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + - text/json + responses: + OK: + body: *ref_24 + isNullable: true + returnType: + body: *ref_24 + isNullable: true + serializedName: StorageAccounts_RegenerateKey + url: >- + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey + name: + fixed: false + raw: StorageAccounts + nameForProperty: StorageAccounts + typeName: + fixed: false + - methods: + - defaultResponse: + isNullable: true + deprecated: false + description: >- + Gets the current usage count and the limit for the resources under the + subscription. + group: + fixed: false + raw: Usage + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: List + parameters: + - clientProperty: *ref_20 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Client Api Version. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + - clientProperty: *ref_21 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Gets subscription credentials which uniquely identify Microsoft + Azure subscription. The subscription ID forms part of the URI + for every service call. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + - text/json + responses: + OK: + body: *ref_27 + isNullable: true + returnType: + body: *ref_27 + isNullable: true + serializedName: Usage_List + url: '/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages' + name: + fixed: false + raw: Usage + nameForProperty: Usage + typeName: + fixed: false +properties: + - *ref_21 + - *ref_20 + - *ref_22 diff --git a/test/Expected/subscriptionId-apiVersion/code-model-v1-yaml.yaml b/test/Expected/subscriptionId-apiVersion/code-model-v1-yaml.yaml new file mode 100644 index 0000000..f211747 --- /dev/null +++ b/test/Expected/subscriptionId-apiVersion/code-model-v1-yaml.yaml @@ -0,0 +1,250 @@ +--- +apiVersion: 2014-04-01-preview +baseUrl: 'https://management.azure.com' +documentation: Some cool documentation. +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - &ref_1 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: SampleResourceGroup + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: resource group name 'testgroup101' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: name + realPath: + - name + serializedName: name + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: resource group location 'West US' + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: location + realPath: + - location + serializedName: location + serializedName: SampleResourceGroup + - *ref_0 +modelsName: Models +name: MicrosoftAzureTestUrl +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Provides a resouce group with name 'testgroup101' and location 'West + US'. + group: + fixed: false + raw: group + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getSampleResourceGroup + parameters: + - clientProperty: &ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Subscription Id. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Subscription Id. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Resource Group name 'testgroup101'. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - clientProperty: &ref_3 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version with value '2014-04-01-preview'. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + realPath: + - api-version + serializedName: api-version + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: API Version with value '2014-04-01-preview'. + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: api-version + serializedName: api-version + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_1 + isNullable: true + returnType: + body: *ref_1 + isNullable: true + serializedName: group_getSampleResourceGroup + url: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' + name: + fixed: false + raw: Group + nameForProperty: Group + typeName: + fixed: false +properties: + - *ref_2 + - *ref_3 diff --git a/test/Expected/url-multi-collectionFormat/code-model-v1-yaml.yaml b/test/Expected/url-multi-collectionFormat/code-model-v1-yaml.yaml new file mode 100644 index 0000000..ba9a272 --- /dev/null +++ b/test/Expected/url-multi-collectionFormat/code-model-v1-yaml.yaml @@ -0,0 +1,215 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestUrlMutliCollectionFormatTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a null array of string using the multi-array format + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayStringMultiNull + parameters: + - collectionFormat: multi + defaultValue: + fixed: false + documentation: + fixed: false + raw: a null array of string using the multi-array format + isConstant: false + isRequired: false + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayQuery + serializedName: arrayQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_ArrayStringMultiNull + url: /queries/array/multi/string/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get an empty array [] of string using the multi-array format' + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayStringMultiEmpty + parameters: + - collectionFormat: multi + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'an empty array [] of string using the multi-array format' + isConstant: false + isRequired: false + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayQuery + serializedName: arrayQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_ArrayStringMultiEmpty + url: /queries/array/multi/string/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' , + null, ''] using the mult-array format + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayStringMultiValid + parameters: + - collectionFormat: multi + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' + , null, ''] using the mult-array format + isConstant: false + isRequired: false + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayQuery + serializedName: arrayQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_ArrayStringMultiValid + url: /queries/array/multi/string/valid + name: + fixed: false + raw: Queries + nameForProperty: Queries + typeName: + fixed: false diff --git a/test/Expected/url/code-model-v1-yaml.yaml b/test/Expected/url/code-model-v1-yaml.yaml new file mode 100644 index 0000000..1d4e44b --- /dev/null +++ b/test/Expected/url/code-model-v1-yaml.yaml @@ -0,0 +1,3488 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest +enumTypes: + - &ref_1 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: UriColor + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: red color + serializedName: red color + - name: green color + serializedName: green color + - name: blue color + serializedName: blue color +errorTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: status + realPath: + - status + serializedName: status + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + serializedName: Error +modelTypes: + - *ref_0 +modelsName: Models +name: AutoRestUrlTestService +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get true Boolean value on path + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanTrue + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 'true' + documentation: + fixed: false + raw: true boolean value + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolPath + serializedName: boolPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_getBooleanTrue + url: '/paths/bool/true/{boolPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get false Boolean value on path + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanFalse + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: false boolean value + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolPath + serializedName: boolPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_getBooleanFalse + url: '/paths/bool/false/{boolPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '1000000' integer value + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntOneMillion + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '1000000' + documentation: + fixed: false + raw: '''1000000'' integer value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: intPath + serializedName: intPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_getIntOneMillion + url: '/paths/int/1000000/{intPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '-1000000' integer value + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntNegativeOneMillion + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-1000000' + documentation: + fixed: false + raw: '''-1000000'' integer value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: intPath + serializedName: intPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_getIntNegativeOneMillion + url: '/paths/int/-1000000/{intPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '10000000000' 64 bit integer value + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getTenBillion + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '10000000000' + documentation: + fixed: false + raw: '''10000000000'' 64 bit integer value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: longPath + serializedName: longPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_getTenBillion + url: '/paths/long/10000000000/{longPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '-10000000000' 64 bit integer value + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNegativeTenBillion + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-10000000000' + documentation: + fixed: false + raw: '''-10000000000'' 64 bit integer value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: longPath + serializedName: longPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_getNegativeTenBillion + url: '/paths/long/-10000000000/{longPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '1.034E+20' numeric value + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: floatScientificPositive + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '103400000000000000000' + documentation: + fixed: false + raw: '''1.034E+20''numeric value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: floatPath + serializedName: floatPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_floatScientificPositive + url: '/paths/float/1.034E+20/{floatPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '-1.034E-20' numeric value + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: floatScientificNegative + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-1.034e-20' + documentation: + fixed: false + raw: '''-1.034E-20''numeric value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: floatPath + serializedName: floatPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_floatScientificNegative + url: '/paths/float/-1.034E-20/{floatPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '9999999.999' numeric value + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: doubleDecimalPositive + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '9999999.999' + documentation: + fixed: false + raw: '''9999999.999''numeric value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: doublePath + serializedName: doublePath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_doubleDecimalPositive + url: '/paths/double/9999999.999/{doublePath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '-9999999.999' numeric value + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: doubleDecimalNegative + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-9999999.999' + documentation: + fixed: false + raw: '''-9999999.999''numeric value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: doublePath + serializedName: doublePath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_doubleDecimalNegative + url: '/paths/double/-9999999.999/{doublePath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '啊齄丂狛狜隣郎隣兀﨩' multi-byte string value + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: stringUnicode + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 啊齄丂狛狜隣郎隣兀﨩 + documentation: + fixed: false + raw: '''啊齄丂狛狜隣郎隣兀﨩''multi-byte string value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringPath + serializedName: stringPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_stringUnicode + url: '/paths/string/unicode/{stringPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get ''begin!*''();:@ &=+$,/?#[]end' + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: stringUrlEncoded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 'begin!*''();:@ &=+$,/?#[]end' + documentation: + fixed: false + raw: '''begin!*''();:@ &=+$,/?#[]end'' url encoded string value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringPath + serializedName: stringPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_stringUrlEncoded + url: >- + /paths/string/begin%21%2A%27%28%29%3B%3A%40%20%26%3D%2B%24%2C%2F%3F%23%5B%5Dend/{stringPath} + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '' + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: stringEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '' + documentation: + fixed: false + raw: ''''' string value' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringPath + serializedName: stringPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_stringEmpty + url: '/paths/string/empty/{stringPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null (should throw) + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: stringNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null string value + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringPath + serializedName: stringPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + BadRequest: + isNullable: true + returnType: + isNullable: true + serializedName: paths_stringNull + url: '/paths/string/null/{stringPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get using uri with 'green color' in path parameter + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: enumValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: send the value green + extensions: + x-ms-enum: + name: UriColor + isConstant: false + isRequired: true + location: path + modelType: *ref_1 + name: + fixed: false + raw: enumPath + serializedName: enumPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_enumValid + url: '/paths/enum/green%20color/{enumPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get null (should throw on the client before the request is sent on + wire) + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: enumNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: send null should throw + extensions: + x-ms-enum: + name: UriColor + isConstant: false + isRequired: true + location: path + modelType: *ref_1 + name: + fixed: false + raw: enumPath + serializedName: enumPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + BadRequest: + isNullable: true + returnType: + isNullable: true + serializedName: paths_enumNull + url: '/paths/string/null/{enumPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '啊齄丂狛狜隣郎隣兀﨩' multibyte value as utf-8 encoded byte array + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: byteMultiByte + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: '''啊齄丂狛狜隣郎隣兀﨩'' multibyte value as utf-8 encoded byte array' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: bytePath + serializedName: bytePath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_byteMultiByte + url: '/paths/byte/multibyte/{bytePath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '' as byte array + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: byteEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '' + documentation: + fixed: false + raw: ''''' as byte array' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: bytePath + serializedName: bytePath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_byteEmpty + url: '/paths/byte/empty/{bytePath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null as byte array (should throw) + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: byteNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null as byte array (should throw) + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: bytePath + serializedName: bytePath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + BadRequest: + isNullable: true + returnType: + isNullable: true + serializedName: paths_byteNull + url: '/paths/byte/null/{bytePath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '2012-01-01' as date + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: DateValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '2012-01-01' + documentation: + fixed: false + raw: '''2012-01-01'' as date' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: datePath + serializedName: datePath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_DateValid + url: '/paths/date/2012-01-01/{datePath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get null as date - this should throw or be unusable on the client + side, depending on date representation + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: DateNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null as date (should throw) + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: datePath + serializedName: datePath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + BadRequest: + isNullable: true + returnType: + isNullable: true + serializedName: paths_DateNull + url: '/paths/date/null/{datePath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get ''2012-01-01T01:01:01Z'' as date-time' + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: DateTimeValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '2012-01-01T01:01:01Z' + documentation: + fixed: false + raw: '''2012-01-01T01:01:01Z'' as date-time' + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: dateTimePath + serializedName: dateTimePath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_DateTimeValid + url: '/paths/datetime/2012-01-01T01%3A01%3A01Z/{dateTimePath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get null as date-time, should be disallowed or throw depending on + representation of date-time + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: DateTimeNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null as date-time + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: dateTimePath + serializedName: dateTimePath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + BadRequest: + isNullable: true + returnType: + isNullable: true + serializedName: paths_DateTimeNull + url: '/paths/datetime/null/{dateTimePath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get 'lorem' encoded value as 'bG9yZW0' (base64url) + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: base64Url + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: base64url encoded value + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + format: base64url + knownPrimaryType: base64Url + name: + fixed: false + raw: Base64Url + name: + fixed: false + raw: base64UrlPath + serializedName: base64UrlPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_base64Url + url: '/paths/string/bG9yZW0/{base64UrlPath}' + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of string ['ArrayPath1', 'begin!*'();:@ &=+$,/?#[]end' , + null, ''] using the csv-array format + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayCsvInPath + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + an array of string ['ArrayPath1', 'begin!*'();:@ &=+$,/?#[]end' + , null, ''] using the csv-array format + isConstant: false + isRequired: true + location: path + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayPath + serializedName: arrayPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_ArrayCsvInPath + url: >- + /paths/array/ArrayPath1%2cbegin%21%2A%27%28%29%3B%3A%40%20%26%3D%2B%24%2C%2F%3F%23%5B%5Dend%2c%2c/{arrayPath} + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get the date 2016-04-13 encoded value as '1460505600' (Unix time) + group: + fixed: false + raw: paths + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: unixTimeUrl + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Unix time encoded value + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + format: unixtime + knownPrimaryType: unixTime + name: + fixed: false + raw: UnixTime + name: + fixed: false + raw: unixTimeUrlPath + serializedName: unixTimeUrlPath + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: paths_unixTimeUrl + url: '/paths/int/1460505600/{unixTimeUrlPath}' + name: + fixed: false + raw: Paths + nameForProperty: Paths + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get true Boolean value on path + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanTrue + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 'true' + documentation: + fixed: false + raw: true boolean value + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolQuery + serializedName: boolQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_getBooleanTrue + url: /queries/bool/true + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get false Boolean value on path + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanFalse + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 'false' + documentation: + fixed: false + raw: false boolean value + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolQuery + serializedName: boolQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_getBooleanFalse + url: /queries/bool/false + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null Boolean value on query (query string should be absent) + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getBooleanNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null boolean value + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: boolean + name: + fixed: false + raw: Boolean + name: + fixed: false + raw: boolQuery + serializedName: boolQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_getBooleanNull + url: /queries/bool/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '1000000' integer value + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntOneMillion + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '1000000' + documentation: + fixed: false + raw: '''1000000'' integer value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: intQuery + serializedName: intQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_getIntOneMillion + url: /queries/int/1000000 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '-1000000' integer value + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntNegativeOneMillion + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-1000000' + documentation: + fixed: false + raw: '''-1000000'' integer value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: intQuery + serializedName: intQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_getIntNegativeOneMillion + url: /queries/int/-1000000 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null integer value (no query parameter) + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getIntNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null integer value + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: intQuery + serializedName: intQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_getIntNull + url: /queries/int/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '10000000000' 64 bit integer value + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getTenBillion + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '10000000000' + documentation: + fixed: false + raw: '''10000000000'' 64 bit integer value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: longQuery + serializedName: longQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_getTenBillion + url: /queries/long/10000000000 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '-10000000000' 64 bit integer value + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getNegativeTenBillion + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-10000000000' + documentation: + fixed: false + raw: '''-10000000000'' 64 bit integer value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: longQuery + serializedName: longQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_getNegativeTenBillion + url: /queries/long/-10000000000 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get 'null 64 bit integer value (no query param in uri) + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLongNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null 64 bit integer value + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: int64 + knownPrimaryType: long + name: + fixed: false + raw: Long + name: + fixed: false + raw: longQuery + serializedName: longQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_getLongNull + url: /queries/long/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '1.034E+20' numeric value + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: floatScientificPositive + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '103400000000000000000' + documentation: + fixed: false + raw: '''1.034E+20''numeric value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: floatQuery + serializedName: floatQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_floatScientificPositive + url: /queries/float/1.034E+20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '-1.034E-20' numeric value + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: floatScientificNegative + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-1.034e-20' + documentation: + fixed: false + raw: '''-1.034E-20''numeric value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: floatQuery + serializedName: floatQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_floatScientificNegative + url: /queries/float/-1.034E-20 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null numeric value (no query parameter) + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: floatNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null numeric value + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: floatQuery + serializedName: floatQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_floatNull + url: /queries/float/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '9999999.999' numeric value + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: doubleDecimalPositive + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '9999999.999' + documentation: + fixed: false + raw: '''9999999.999''numeric value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: doubleQuery + serializedName: doubleQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_doubleDecimalPositive + url: /queries/double/9999999.999 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '-9999999.999' numeric value + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: doubleDecimalNegative + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '-9999999.999' + documentation: + fixed: false + raw: '''-9999999.999''numeric value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: doubleQuery + serializedName: doubleQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_doubleDecimalNegative + url: /queries/double/-9999999.999 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null numeric value (no query parameter) + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: doubleNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null numeric value + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: double + knownPrimaryType: double + name: + fixed: false + raw: Double + name: + fixed: false + raw: doubleQuery + serializedName: doubleQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_doubleNull + url: /queries/double/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '啊齄丂狛狜隣郎隣兀﨩' multi-byte string value + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: stringUnicode + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 啊齄丂狛狜隣郎隣兀﨩 + documentation: + fixed: false + raw: '''啊齄丂狛狜隣郎隣兀﨩''multi-byte string value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringQuery + serializedName: stringQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_stringUnicode + url: /queries/string/unicode/ + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get ''begin!*''();:@ &=+$,/?#[]end' + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: stringUrlEncoded + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: 'begin!*''();:@ &=+$,/?#[]end' + documentation: + fixed: false + raw: '''begin!*''();:@ &=+$,/?#[]end'' url encoded string value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringQuery + serializedName: stringQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_stringUrlEncoded + url: >- + /queries/string/begin%21%2A%27%28%29%3B%3A%40%20%26%3D%2B%24%2C%2F%3F%23%5B%5Dend + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '' + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: stringEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '' + documentation: + fixed: false + raw: ''''' string value' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringQuery + serializedName: stringQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_stringEmpty + url: /queries/string/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null (no query parameter in url) + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: stringNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null string value + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: stringQuery + serializedName: stringQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_stringNull + url: /queries/string/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get using uri with query parameter 'green color' + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: enumValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: '''green color'' enum value' + extensions: + x-ms-enum: + name: UriColor + isConstant: false + isRequired: false + location: query + modelType: *ref_1 + name: + fixed: false + raw: enumQuery + serializedName: enumQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_enumValid + url: /queries/enum/green%20color + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null (no query parameter in url) + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: enumNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null string value + extensions: + x-ms-enum: + name: UriColor + isConstant: false + isRequired: false + location: query + modelType: *ref_1 + name: + fixed: false + raw: enumQuery + serializedName: enumQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_enumNull + url: /queries/enum/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '啊齄丂狛狜隣郎隣兀﨩' multibyte value as utf-8 encoded byte array + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: byteMultiByte + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: '''啊齄丂狛狜隣郎隣兀﨩'' multibyte value as utf-8 encoded byte array' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: byteQuery + serializedName: byteQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_byteMultiByte + url: /queries/byte/multibyte + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '' as byte array + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: byteEmpty + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '' + documentation: + fixed: false + raw: ''''' as byte array' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: byteQuery + serializedName: byteQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_byteEmpty + url: /queries/byte/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null as byte array (no query parameters in uri) + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: byteNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null as byte array (no query parameters in uri) + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: byte + knownPrimaryType: byteArray + name: + fixed: false + raw: ByteArray + name: + fixed: false + raw: byteQuery + serializedName: byteQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_byteNull + url: /queries/byte/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get '2012-01-01' as date + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: DateValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '2012-01-01' + documentation: + fixed: false + raw: '''2012-01-01'' as date' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: dateQuery + serializedName: dateQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_DateValid + url: /queries/date/2012-01-01 + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get null as date - this should result in no query parameters in uri + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: DateNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null as date (no query parameters in uri) + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: date + knownPrimaryType: date + name: + fixed: false + raw: Date + name: + fixed: false + raw: dateQuery + serializedName: dateQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_DateNull + url: /queries/date/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get ''2012-01-01T01:01:01Z'' as date-time' + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: DateTimeValid + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: '2012-01-01T01:01:01Z' + documentation: + fixed: false + raw: '''2012-01-01T01:01:01Z'' as date-time' + isConstant: true + isRequired: true + location: query + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: dateTimeQuery + serializedName: dateTimeQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_DateTimeValid + url: /queries/datetime/2012-01-01T01%3A01%3A01Z + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get null as date-time, should result in no query parameters in uri' + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: DateTimeNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: null as date-time (no query parameters) + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + format: date-time + knownPrimaryType: dateTime + name: + fixed: false + raw: DateTime + name: + fixed: false + raw: dateTimeQuery + serializedName: dateTimeQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_DateTimeNull + url: /queries/datetime/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' , + null, ''] using the csv-array format + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayStringCsvValid + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' + , null, ''] using the csv-array format + isConstant: false + isRequired: false + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayQuery + serializedName: arrayQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_ArrayStringCsvValid + url: /queries/array/csv/string/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: Get a null array of string using the csv-array format + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayStringCsvNull + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + raw: a null array of string using the csv-array format + isConstant: false + isRequired: false + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayQuery + serializedName: arrayQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_ArrayStringCsvNull + url: /queries/array/csv/string/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: 'Get an empty array [] of string using the csv-array format' + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayStringCsvEmpty + parameters: + - collectionFormat: csv + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'an empty array [] of string using the csv-array format' + isConstant: false + isRequired: false + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayQuery + serializedName: arrayQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_ArrayStringCsvEmpty + url: /queries/array/csv/string/empty + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' , + null, ''] using the ssv-array format + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayStringSsvValid + parameters: + - collectionFormat: ssv + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' + , null, ''] using the ssv-array format + isConstant: false + isRequired: false + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayQuery + serializedName: arrayQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_ArrayStringSsvValid + url: /queries/array/ssv/string/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' , + null, ''] using the tsv-array format + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayStringTsvValid + parameters: + - collectionFormat: tsv + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' + , null, ''] using the tsv-array format + isConstant: false + isRequired: false + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayQuery + serializedName: arrayQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_ArrayStringTsvValid + url: /queries/array/tsv/string/valid + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + Get an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' , + null, ''] using the pipes-array format + group: + fixed: false + raw: queries + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: ArrayStringPipesValid + parameters: + - collectionFormat: pipes + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + an array of string ['ArrayQuery1', 'begin!*'();:@ &=+$,/?#[]end' + , null, ''] using the pipes-array format + isConstant: false + isRequired: false + location: query + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: arrayQuery + serializedName: arrayQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: queries_ArrayStringPipesValid + url: /queries/array/pipes/string/valid + name: + fixed: false + raw: Queries + nameForProperty: Queries + typeName: + fixed: false + - methods: + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + send globalStringPath='globalStringPath', + pathItemStringPath='pathItemStringPath', + localStringPath='localStringPath', + globalStringQuery='globalStringQuery', + pathItemStringQuery='pathItemStringQuery', + localStringQuery='localStringQuery' + group: + fixed: false + raw: pathItems + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getAllWithValues + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value 'localStringPath' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localStringPath + serializedName: localStringPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value 'localStringQuery' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localStringQuery + serializedName: localStringQuery + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A string value 'pathItemStringPath' that appears in the path + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathItemStringPath + serializedName: pathItemStringPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A string value 'pathItemStringQuery' that appears as a query + parameter + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathItemStringQuery + serializedName: pathItemStringQuery + - clientProperty: &ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A string value 'globalItemStringPath' that appears in the path + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringPath + realPath: + - globalStringPath + serializedName: globalStringPath + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A string value 'globalItemStringPath' that appears in the path + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringPath + serializedName: globalStringPath + - clientProperty: &ref_3 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value null + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringQuery + realPath: + - globalStringQuery + serializedName: globalStringQuery + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value null + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringQuery + serializedName: globalStringQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: pathItems_getAllWithValues + url: >- + /pathitem/nullable/globalStringPath/{globalStringPath}/pathItemStringPath/{pathItemStringPath}/localStringPath/{localStringPath}/globalStringQuery/pathItemStringQuery/localStringQuery + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + send globalStringPath='globalStringPath', + pathItemStringPath='pathItemStringPath', + localStringPath='localStringPath', globalStringQuery=null, + pathItemStringQuery='pathItemStringQuery', + localStringQuery='localStringQuery' + group: + fixed: false + raw: pathItems + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getGlobalQueryNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value 'localStringPath' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localStringPath + serializedName: localStringPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value 'localStringQuery' + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localStringQuery + serializedName: localStringQuery + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A string value 'pathItemStringPath' that appears in the path + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathItemStringPath + serializedName: pathItemStringPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A string value 'pathItemStringQuery' that appears as a query + parameter + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathItemStringQuery + serializedName: pathItemStringQuery + - clientProperty: *ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A string value 'globalItemStringPath' that appears in the path + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringPath + serializedName: globalStringPath + - clientProperty: *ref_3 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value null + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringQuery + serializedName: globalStringQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: pathItems_getGlobalQueryNull + url: >- + /pathitem/nullable/globalStringPath/{globalStringPath}/pathItemStringPath/{pathItemStringPath}/localStringPath/{localStringPath}/null/pathItemStringQuery/localStringQuery + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + send globalStringPath=globalStringPath, + pathItemStringPath='pathItemStringPath', + localStringPath='localStringPath', globalStringQuery=null, + pathItemStringQuery='pathItemStringQuery', localStringQuery=null + group: + fixed: false + raw: pathItems + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getGlobalAndLocalQueryNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value 'localStringPath' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localStringPath + serializedName: localStringPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain null value + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localStringQuery + serializedName: localStringQuery + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A string value 'pathItemStringPath' that appears in the path + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathItemStringPath + serializedName: pathItemStringPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + A string value 'pathItemStringQuery' that appears as a query + parameter + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathItemStringQuery + serializedName: pathItemStringQuery + - clientProperty: *ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A string value 'globalItemStringPath' that appears in the path + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringPath + serializedName: globalStringPath + - clientProperty: *ref_3 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value null + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringQuery + serializedName: globalStringQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: pathItems_getGlobalAndLocalQueryNull + url: >- + /pathitem/nullable/globalStringPath/{globalStringPath}/pathItemStringPath/{pathItemStringPath}/localStringPath/{localStringPath}/null/pathItemStringQuery/null + - defaultResponse: + body: *ref_0 + isNullable: true + deprecated: false + description: >- + send globalStringPath='globalStringPath', + pathItemStringPath='pathItemStringPath', + localStringPath='localStringPath', + globalStringQuery='globalStringQuery', pathItemStringQuery=null, + localStringQuery=null + group: + fixed: false + raw: pathItems + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getLocalPathItemQueryNull + parameters: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value 'localStringPath' + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localStringPath + serializedName: localStringPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value null + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: localStringQuery + serializedName: localStringQuery + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A string value 'pathItemStringPath' that appears in the path + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathItemStringPath + serializedName: pathItemStringPath + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value null + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: pathItemStringQuery + serializedName: pathItemStringQuery + - clientProperty: *ref_2 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: A string value 'globalItemStringPath' that appears in the path + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringPath + serializedName: globalStringPath + - clientProperty: *ref_3 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: should contain value null + isConstant: false + isRequired: false + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: globalStringQuery + serializedName: globalStringQuery + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: pathItems_getLocalPathItemQueryNull + url: >- + /pathitem/nullable/globalStringPath/{globalStringPath}/pathItemStringPath/{pathItemStringPath}/localStringPath/{localStringPath}/globalStringQuery/null/null + name: + fixed: false + raw: PathItems + nameForProperty: PathItems + typeName: + fixed: false +properties: + - *ref_2 + - *ref_3 diff --git a/test/Expected/validation/code-model-v1-yaml.yaml b/test/Expected/validation/code-model-v1-yaml.yaml new file mode 100644 index 0000000..88e69b6 --- /dev/null +++ b/test/Expected/validation/code-model-v1-yaml.yaml @@ -0,0 +1,791 @@ +--- +apiVersion: 1.0.0 +baseUrl: 'http://localhost' +documentation: Test Infrastructure for AutoRest. No server backend exists for these tests. +enumTypes: + - &ref_2 + $type: EnumType + modelAsExtensible: false + modelAsString: false + name: + fixed: false + raw: EnumConst + underlyingType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + values: + - name: constant_string_as_enum + serializedName: constant_string_as_enum +errorTypes: + - &ref_3 + $type: CompositeType + containsConstantProperties: false + name: + fixed: false + raw: Error + properties: + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + format: int32 + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: code + realPath: + - code + serializedName: code + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: message + realPath: + - message + serializedName: message + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: fields + realPath: + - fields + serializedName: fields + serializedName: Error +modelTypes: + - &ref_0 + $type: CompositeType + containsConstantProperties: true + documentation: The product documentation. + name: + fixed: false + raw: ChildProduct + properties: + - collectionFormat: none + defaultValue: + fixed: false + raw: constant + documentation: + fixed: false + raw: Constant string + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: constProperty + realPath: + - constProperty + serializedName: constProperty + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Count + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: count + realPath: + - count + serializedName: count + serializedName: ChildProduct + - &ref_1 + $type: CompositeType + containsConstantProperties: true + documentation: The product documentation. + name: + fixed: false + raw: ConstantProduct + properties: + - collectionFormat: none + defaultValue: + fixed: false + raw: constant + documentation: + fixed: false + raw: Constant string + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: constProperty + realPath: + - constProperty + serializedName: constProperty + - collectionFormat: none + defaultValue: + fixed: false + raw: constant2 + documentation: + fixed: false + raw: Constant string2 + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: constProperty2 + realPath: + - constProperty2 + serializedName: constProperty2 + serializedName: ConstantProduct + - &ref_4 + $type: CompositeType + containsConstantProperties: true + documentation: The product documentation. + name: + fixed: false + raw: Product + properties: + - collectionFormat: none + constraints: + MaxItems: '6' + MinItems: '0' + UniqueItems: 'true' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Non required array of unique items from 0 to 6 elements. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: SequenceType + elementType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + name: + fixed: false + raw: display_names + realPath: + - display_names + serializedName: display_names + - collectionFormat: none + constraints: + ExclusiveMaximum: '100' + ExclusiveMinimum: '0' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Non required int betwen 0 and 100 exclusive. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: capacity + realPath: + - capacity + serializedName: capacity + - collectionFormat: none + constraints: + Pattern: 'http://\w+' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Image URL representing the product. + isConstant: false + isReadOnly: false + isRequired: false + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: image + realPath: + - image + serializedName: image + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: false + isReadOnly: false + isRequired: true + modelType: *ref_0 + name: + fixed: false + raw: child + realPath: + - child + serializedName: child + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + isConstant: true + isReadOnly: false + isRequired: true + modelType: *ref_1 + name: + fixed: false + raw: constChild + realPath: + - constChild + serializedName: constChild + - collectionFormat: none + defaultValue: + fixed: false + raw: '0' + documentation: + fixed: false + raw: Constant int + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: constInt + realPath: + - constInt + serializedName: constInt + - collectionFormat: none + defaultValue: + fixed: false + raw: constant + documentation: + fixed: false + raw: Constant string + isConstant: true + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: constString + realPath: + - constString + serializedName: constString + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Constant string as Enum + extensions: + x-ms-enum: + modelAsString: false + name: EnumConst + isConstant: false + isReadOnly: false + isRequired: false + modelType: *ref_2 + name: + fixed: false + raw: constStringAsEnum + realPath: + - constStringAsEnum + serializedName: constStringAsEnum + serializedName: Product + - *ref_3 +modelsName: Models +name: AutoRestValidationTest +namespace: '' +operations: + - methods: + - defaultResponse: + body: *ref_3 + isNullable: true + deprecated: false + description: Validates input parameters on the method. See swagger for details. + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: validationOfMethodParameters + parameters: + - clientProperty: &ref_5 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Subscription ID. + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + realPath: + - subscriptionId + serializedName: subscriptionId + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Subscription ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - collectionFormat: none + constraints: + MaxLength: '10' + MinLength: '3' + Pattern: '[a-zA-Z0-9]+' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Required string between 3 and 10 chars with pattern + [a-zA-Z0-9]+. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '100' + MultipleOf: '10' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Required int multiple of 10 from 100 to 1000. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - clientProperty: &ref_6 + collectionFormat: none + constraints: + Pattern: '\d{2}-\d{2}-\d{4}' + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Required string following pattern \d{2}-\d{2}-\d{4}' + isConstant: false + isReadOnly: false + isRequired: true + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: apiVersion + realPath: + - apiVersion + serializedName: apiVersion + collectionFormat: none + constraints: + Pattern: '\d{2}-\d{2}-\d{4}' + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Required string following pattern \d{2}-\d{2}-\d{4}' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: apiVersion + serializedName: apiVersion + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_4 + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: validationOfMethodParameters + summary: '' + url: '/fakepath/{subscriptionId}/{resourceGroupName}/{id}' + - defaultResponse: + body: *ref_3 + isNullable: true + deprecated: false + description: Validates body parameters on the method. See swagger for details. + extensions: + x-ms-requestBody-index: '3' + group: + fixed: false + raw: '' + hidden: false + httpMethod: put + isAbsoluteUrl: false + name: + fixed: false + raw: validationOfBody + parameters: + - clientProperty: *ref_5 + collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + raw: Subscription ID. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: subscriptionId + serializedName: subscriptionId + - collectionFormat: none + constraints: + MaxLength: '10' + MinLength: '3' + Pattern: '[a-zA-Z0-9]+' + defaultValue: + fixed: false + documentation: + fixed: false + raw: >- + Required string between 3 and 10 chars with pattern + [a-zA-Z0-9]+. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: resourceGroupName + serializedName: resourceGroupName + - collectionFormat: none + constraints: + InclusiveMaximum: '1000' + InclusiveMinimum: '100' + MultipleOf: '10' + defaultValue: + fixed: false + documentation: + fixed: false + raw: Required int multiple of 10 from 100 to 1000. + isConstant: false + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: int + name: + fixed: false + raw: Int + name: + fixed: false + raw: id + serializedName: id + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: body + isConstant: false + isRequired: false + location: body + modelType: *ref_4 + name: + fixed: false + raw: body + serializedName: body + - clientProperty: *ref_6 + collectionFormat: none + constraints: + Pattern: '\d{2}-\d{2}-\d{4}' + defaultValue: + fixed: false + documentation: + fixed: false + raw: 'Required string following pattern \d{2}-\d{2}-\d{4}' + isConstant: false + isRequired: true + location: query + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: apiVersion + serializedName: apiVersion + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_4 + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: validationOfBody + summary: '' + url: '/fakepath/{subscriptionId}/{resourceGroupName}/{id}' + - defaultResponse: + isNullable: true + deprecated: false + group: + fixed: false + raw: '' + hidden: false + httpMethod: get + isAbsoluteUrl: false + name: + fixed: false + raw: getWithConstantInPath + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: constant + documentation: + fixed: false + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: constantParam + serializedName: constantParam + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + isNullable: true + returnType: + isNullable: true + serializedName: getWithConstantInPath + url: '/validation/constantsInPath/{constantParam}/value' + - defaultResponse: + isNullable: true + deprecated: false + extensions: + x-ms-requestBody-index: '1' + group: + fixed: false + raw: '' + hidden: false + httpMethod: post + isAbsoluteUrl: false + name: + fixed: false + raw: postWithConstantInBody + parameters: + - collectionFormat: none + defaultValue: + fixed: false + raw: constant + documentation: + fixed: false + isConstant: true + isRequired: true + location: path + modelType: + $type: PrimaryType + knownPrimaryType: string + name: + fixed: false + raw: String + name: + fixed: false + raw: constantParam + serializedName: constantParam + - collectionFormat: none + defaultValue: + fixed: false + documentation: + fixed: false + extensions: + x-ms-requestBody-name: body + isConstant: false + isRequired: false + location: body + modelType: *ref_4 + name: + fixed: false + raw: body + serializedName: body + requestContentType: application/json; charset=utf-8 + responseContentTypes: + - application/json + responses: + OK: + body: *ref_4 + isNullable: true + returnType: + body: *ref_4 + isNullable: true + serializedName: postWithConstantInBody + url: '/validation/constantsInPath/{constantParam}/value' + name: + fixed: false + raw: '' + nameForProperty: AutoRestValidationTest + typeName: + fixed: false +properties: + - *ref_5 + - *ref_6